diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index a94d07204..fc4e057a5 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -7624,6 +7624,385 @@ } } }, + "/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", + "example": "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", @@ -7740,7 +8119,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" @@ -7748,7 +8127,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": [ { @@ -23340,172 +23719,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", @@ -29900,261 +30113,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": [ - { - "$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/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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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/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", @@ -56600,190 +56558,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", @@ -61784,8 +61558,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -71880,94 +71658,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", @@ -75161,83 +74851,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": [ - { - "$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", @@ -76440,7 +76053,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" @@ -76448,7 +76061,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": [ { @@ -108940,6 +108553,193 @@ "value" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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": { @@ -114247,103 +114047,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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" - ] - }, "nullable-projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -281703,6 +281406,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": { @@ -286086,82 +285866,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, @@ -289488,42 +289192,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", @@ -299648,44 +299316,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", @@ -306599,42 +306229,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": [ @@ -307316,44 +306910,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": [ { @@ -309559,6 +309115,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.", @@ -311216,6 +310781,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": { @@ -311247,7 +310857,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": { @@ -311362,8 +310972,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": { @@ -311372,8 +310982,8 @@ } } }, - "temporary_redirect": { - "description": "Temporary Redirect", + "gone": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -311521,7 +311131,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 51232a602..90b76531e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -5379,6 +5379,285 @@ 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 + example: 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 @@ -5454,7 +5733,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. @@ -5467,7 +5746,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" @@ -16930,121 +17209,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 @@ -21621,191 +21785,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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 @@ -41073,131 +41052,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 @@ -44821,8 +44675,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: @@ -52193,71 +52048,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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 @@ -54508,59 +54298,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 @@ -55347,7 +55084,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. @@ -55360,7 +55097,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" @@ -79251,6 +78988,151 @@ components: required: - property_name - value + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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: @@ -83569,86 +83451,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 - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - "$ref": "#/components/schemas/nullable-simple-user" - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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 nullable-projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project @@ -211023,6 +210825,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: @@ -214694,74 +214550,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 @@ -217635,39 +217423,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 @@ -226303,39 +226058,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 @@ -232382,39 +232104,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: @@ -232996,39 +232685,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' @@ -234989,6 +234645,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 @@ -236369,6 +236032,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: @@ -236388,7 +236078,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: @@ -236462,14 +236152,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: @@ -236563,7 +236253,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index a94d07204..fc4e057a5 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -7624,6 +7624,385 @@ } } }, + "/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", + "example": "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", @@ -7740,7 +8119,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" @@ -7748,7 +8127,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": [ { @@ -23340,172 +23719,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", @@ -29900,261 +30113,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": [ - { - "$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/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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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/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", @@ -56600,190 +56558,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", @@ -61784,8 +61558,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -71880,94 +71658,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", @@ -75161,83 +74851,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": [ - { - "$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", @@ -76440,7 +76053,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" @@ -76448,7 +76061,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": [ { @@ -108940,6 +108553,193 @@ "value" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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": { @@ -114247,103 +114047,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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" - ] - }, "nullable-projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -281703,6 +281406,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": { @@ -286086,82 +285866,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, @@ -289488,42 +289192,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", @@ -299648,44 +299316,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", @@ -306599,42 +306229,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": [ @@ -307316,44 +306910,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": [ { @@ -309559,6 +309115,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.", @@ -311216,6 +310781,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": { @@ -311247,7 +310857,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": { @@ -311362,8 +310972,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": { @@ -311372,8 +310982,8 @@ } } }, - "temporary_redirect": { - "description": "Temporary Redirect", + "gone": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -311521,7 +311131,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 51232a602..90b76531e 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -5379,6 +5379,285 @@ 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 + example: 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 @@ -5454,7 +5733,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. @@ -5467,7 +5746,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" @@ -16930,121 +17209,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 @@ -21621,191 +21785,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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 @@ -41073,131 +41052,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 @@ -44821,8 +44675,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: @@ -52193,71 +52048,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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 @@ -54508,59 +54298,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 @@ -55347,7 +55084,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. @@ -55360,7 +55097,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" @@ -79251,6 +78988,151 @@ components: required: - property_name - value + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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: @@ -83569,86 +83451,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 - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - "$ref": "#/components/schemas/nullable-simple-user" - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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 nullable-projects-v2-status-update: title: Projects v2 Status Update description: An status update belonging to a project @@ -211023,6 +210825,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: @@ -214694,74 +214550,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 @@ -217635,39 +217423,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 @@ -226303,39 +226058,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 @@ -232382,39 +232104,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: @@ -232996,39 +232685,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' @@ -234989,6 +234645,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 @@ -236369,6 +236032,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: @@ -236388,7 +236078,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: @@ -236462,14 +236152,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: @@ -236563,7 +236253,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index ca4a91a37..af18eac52 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -53382,6 +53382,1264 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -54063,7 +55321,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" @@ -54071,7 +55329,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": [ { @@ -54140,7 +55398,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -128629,847 +129887,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -180891,965 +181308,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -406507,1193 +405965,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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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" - } - } - } - } - } + } + }, + "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" + } }, - "403": { - "description": "Forbidden", + { + "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": { @@ -407715,11 +406057,88 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" + } }, - "404": { - "description": "Resource not found", + { + "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": { @@ -407741,11 +406160,88 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" + } }, - "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -407767,29 +406263,33 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -407804,12 +406304,9 @@ "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": { @@ -464864,8 +463361,12 @@ "nullable": true } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -550742,416 +549243,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -581833,421 +579924,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", @@ -605411,7 +603087,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" @@ -605419,7 +603095,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": [ { @@ -605488,7 +603164,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 82185a526..607d40cbf 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -990,7 +990,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &112 + schema: &113 title: Validation Error Simple description: Validation Error Simple type: object @@ -1023,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &635 + - &634 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1579,7 +1579,7 @@ paths: schema: type: integer default: 30 - - &194 + - &195 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1595,7 +1595,7 @@ paths: application/json: schema: type: array - items: &195 + items: &196 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1675,7 +1675,7 @@ paths: - installation_id - repository_id examples: - default: &196 + default: &197 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1734,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &111 + schema: &112 title: Validation Error description: Validation Error type: object @@ -1803,7 +1803,7 @@ paths: description: Response content: application/json: - schema: &197 + schema: &198 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1917,7 +1917,7 @@ paths: - request - response examples: - default: &198 + default: &199 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -7414,7 +7414,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &168 + code_scanning_options: &169 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7608,7 +7608,7 @@ paths: description: Response content: application/json: - schema: &170 + schema: &171 type: array description: A list of default code security configurations items: @@ -7624,7 +7624,7 @@ paths: default configuration: *43 examples: - default: &171 + default: &172 value: - default_for_new_repos: public configuration: @@ -7955,7 +7955,7 @@ paths: - *42 - *45 responses: - '204': &172 + '204': &173 description: A header with no content is returned. '400': *14 '403': *29 @@ -8082,7 +8082,7 @@ paths: default: value: default_for_new_repos: all - configuration: &169 + configuration: &170 value: id: 1325 target_type: organization @@ -8167,7 +8167,7 @@ paths: application/json: schema: type: array - items: &173 + items: &174 type: object description: Repositories associated with a code security configuration and attachment status @@ -8468,7 +8468,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &174 + repository: &175 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8562,7 +8562,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &179 + - &180 name: state in: query description: |- @@ -8571,7 +8571,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &180 + - &181 name: severity in: query description: |- @@ -8580,7 +8580,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &181 + - &182 name: ecosystem in: query description: |- @@ -8589,14 +8589,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &182 + - &183 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 - - &183 + - &184 name: epss_percentage in: query description: |- @@ -8608,7 +8608,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &474 + - &472 name: has in: query description: |- @@ -8622,7 +8622,7 @@ paths: type: string enum: - patch - - &184 + - &185 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8632,7 +8632,7 @@ paths: enum: - development - runtime - - &185 + - &186 name: sort in: query description: |- @@ -8658,11 +8658,11 @@ paths: application/json: schema: type: array - items: &186 + items: &187 type: object description: A Dependabot alert. properties: - number: &158 + number: &159 type: integer description: The security alert number. readOnly: true @@ -8724,7 +8724,7 @@ paths: - unknown - direct - transitive - security_advisory: &475 + security_advisory: &473 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8927,29 +8927,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *52 - url: &161 + url: &162 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &162 + html_url: &163 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &159 + created_at: &160 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: &160 + updated_at: &161 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: &164 + dismissed_at: &165 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8979,14 +8979,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &163 + fixed_at: &164 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &476 + auto_dismissed_at: &474 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9012,7 +9012,7 @@ paths: - repository additionalProperties: false examples: - default: &187 + default: &188 value: - number: 2 state: dismissed @@ -9796,7 +9796,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &176 + properties: &177 login: type: string example: github @@ -9837,7 +9837,7 @@ paths: type: string example: A great organization nullable: true - required: &177 + required: &178 - login - url - id @@ -10282,7 +10282,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &524 + properties: &523 id: type: integer format: int64 @@ -10543,7 +10543,7 @@ paths: timeline_url: type: string format: uri - type: &216 + type: &217 title: Issue Type description: The type of issue. type: object @@ -10654,7 +10654,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &647 + sub_issues_summary: &646 title: Sub-issues Summary type: object properties: @@ -10674,7 +10674,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &648 + issue_dependencies_summary: &647 title: Issue Dependencies Summary type: object properties: @@ -10693,7 +10693,7 @@ paths: - total_blocking issue_field_values: type: array - items: &649 + items: &648 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10753,7 +10753,7 @@ paths: - node_id - data_type - value - required: &525 + required: &524 - assignee - closed_at - comments @@ -10774,7 +10774,7 @@ paths: - user - created_at - updated_at - comment: &522 + comment: &521 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11344,7 +11344,7 @@ paths: url: type: string format: uri - user: &661 + user: &660 title: Public User description: Public User type: object @@ -13214,7 +13214,7 @@ paths: - closed - all default: open - - &219 + - &220 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13265,7 +13265,7 @@ paths: type: array items: *82 examples: - default: &220 + default: &221 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14719,7 +14719,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &333 + '301': &331 description: Moved permanently content: application/json: @@ -14741,7 +14741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &554 + - &553 name: all description: If `true`, show notifications marked as read. in: query @@ -14749,7 +14749,7 @@ paths: schema: type: boolean default: false - - &555 + - &554 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14759,7 +14759,7 @@ paths: type: boolean default: false - *72 - - &556 + - &555 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -14791,11 +14791,11 @@ paths: properties: id: type: string - repository: &142 + repository: &143 title: Minimal Repository description: Minimal Repository type: object - properties: &189 + properties: &190 id: type: integer format: int64 @@ -15145,7 +15145,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &190 + required: &191 - archive_url - assignees_url - blobs_url @@ -15233,7 +15233,7 @@ paths: - url - subscription_url examples: - default: &557 + default: &556 value: - id: '1' repository: @@ -16101,7 +16101,7 @@ paths: - property_name - value examples: - default: &563 + default: &562 value: - property_name: environment value: production @@ -16151,7 +16151,7 @@ paths: required: - properties examples: - default: &564 + default: &563 value: properties: - property_name: environment @@ -16172,6 +16172,482 @@ 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: + - *63 + 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 + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - 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': *29 + '500': *103 + 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: + - *63 + - &105 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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': *29 + '500': *103 + '503': *104 + 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: + - *63 + - *105 + 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 + example: 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': *25 + '403': *29 + '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: + - *63 + - *105 + 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': *29 + '500': *103 + '503': *104 + 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 @@ -16187,7 +16663,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *63 - - &105 + - &106 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, @@ -16196,7 +16672,7 @@ paths: required: false schema: type: integer - - &107 + - &108 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 @@ -16205,7 +16681,7 @@ paths: required: false schema: type: integer - - &106 + - &107 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 @@ -16220,14 +16696,14 @@ paths: required: false schema: type: string - - &705 + - &704 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &108 + - &109 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16365,8 +16841,8 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *63 - - *105 - - &708 + - *106 + - &707 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16375,7 +16851,7 @@ paths: required: false schema: type: integer - - *106 + - *107 responses: '200': description: Billing usage report response for an organization @@ -16459,7 +16935,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. @@ -16472,21 +16948,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: - *63 - - *105 - - *107 - *106 - - &709 + - *108 + - *107 + - &708 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *108 - - &710 + - *109 + - &709 name: sku description: The SKU to query for usage. in: query @@ -16495,7 +16971,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: @@ -16629,7 +17105,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &110 title: Organization Full description: Organization Full type: object @@ -16948,7 +17424,7 @@ paths: - updated_at - archived_at examples: - default-response: &110 + default-response: &111 value: login: github id: 1 @@ -17264,17 +17740,17 @@ paths: description: Response content: application/json: - schema: *109 + schema: *110 examples: - default: *110 + default: *111 '422': description: Validation failed content: application/json: schema: oneOf: - - *111 - *112 + - *113 '409': *47 x-github: githubCloudOnly: false @@ -17388,7 +17864,7 @@ paths: type: integer repository_cache_usages: type: array - items: &338 + items: &336 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17461,7 +17937,7 @@ paths: type: integer runners: type: array - items: &113 + items: &114 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17515,7 +17991,7 @@ paths: - display_name - source nullable: true - machine_size_details: &121 + machine_size_details: &122 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17611,7 +18087,7 @@ paths: - public_ip_enabled - platform examples: - default: &141 + default: &142 value: total_count: 2 runners: @@ -17748,9 +18224,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: &122 + default: &123 value: id: 5 name: My hosted ubuntu runner @@ -17807,7 +18283,7 @@ paths: type: integer images: type: array - items: &114 + items: &115 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -17858,7 +18334,7 @@ paths: - latest_version - state examples: - default: &116 + default: &117 value: total_count: 2 image_versions: @@ -17890,7 +18366,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *63 - - &115 + - &116 name: image_definition_id description: Image definition ID of custom image in: path @@ -17902,7 +18378,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *115 examples: default: value: @@ -17933,7 +18409,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *63 - - *115 + - *116 responses: '204': description: Response @@ -17956,7 +18432,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: - - *115 + - *116 - *63 responses: '200': @@ -17973,7 +18449,7 @@ paths: type: integer image_versions: type: array - items: &117 + items: &118 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18006,7 +18482,7 @@ paths: - created_on - state_details examples: - default: *116 + default: *117 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18027,8 +18503,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: - *63 - - *115 - - &118 + - *116 + - &119 name: version description: Version of a custom image in: path @@ -18041,7 +18517,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *118 examples: default: value: @@ -18068,8 +18544,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *63 - - *115 - - *118 + - *116 + - *119 responses: '204': description: Response @@ -18106,7 +18582,7 @@ paths: type: integer images: type: array - items: &119 + items: &120 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18142,7 +18618,7 @@ paths: - display_name - source examples: - default: &120 + default: &121 value: id: ubuntu-20.04 platform: linux-x64 @@ -18182,9 +18658,9 @@ paths: type: integer images: type: array - items: *119 + items: *120 examples: - default: *120 + default: *121 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18270,7 +18746,7 @@ paths: type: integer machine_specs: type: array - items: *121 + items: *122 examples: default: value: @@ -18340,7 +18816,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *63 - - &123 + - &124 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18352,9 +18828,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 headers: Link: *54 x-github: @@ -18375,7 +18851,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *63 - - *123 + - *124 requestBody: required: true content: @@ -18418,9 +18894,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18437,15 +18913,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *63 - - *123 + - *124 responses: '202': description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18471,7 +18947,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &124 + schema: &125 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18485,7 +18961,7 @@ paths: required: - include_claim_keys examples: - default: &125 + default: &126 value: include_claim_keys: - repo @@ -18512,15 +18988,15 @@ paths: required: true content: application/json: - schema: *124 + schema: *125 examples: - default: *125 + default: *126 responses: '201': description: Empty response content: application/json: - schema: &151 + schema: &152 title: Empty Object description: An object without any properties. type: object @@ -18559,7 +19035,7 @@ paths: schema: type: object properties: - enabled_repositories: &126 + enabled_repositories: &127 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -18572,7 +19048,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: &127 + allowed_actions: &128 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -18580,12 +19056,12 @@ paths: - all - local_only - selected - selected_actions_url: &344 + selected_actions_url: &342 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: &128 + sha_pinning_required: &129 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -18627,9 +19103,9 @@ paths: schema: type: object properties: - enabled_repositories: *126 - allowed_actions: *127 - sha_pinning_required: *128 + enabled_repositories: *127 + allowed_actions: *128 + sha_pinning_required: *129 required: - enabled_repositories examples: @@ -18663,7 +19139,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &346 type: object properties: days: @@ -18705,7 +19181,7 @@ paths: required: true content: application/json: - schema: &349 + schema: &347 type: object properties: days: @@ -18748,7 +19224,7 @@ paths: description: Response content: application/json: - schema: &129 + schema: &130 type: object properties: approval_policy: @@ -18762,7 +19238,7 @@ paths: required: - approval_policy examples: - default: &350 + default: &348 value: approval_policy: first_time_contributors '404': *6 @@ -18793,7 +19269,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *130 examples: default: summary: Set approval policy to first time contributors @@ -18821,7 +19297,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &349 type: object required: - run_workflows_from_fork_pull_requests @@ -18847,7 +19323,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &130 + default: &131 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -18875,7 +19351,7 @@ paths: required: true content: application/json: - schema: &352 + schema: &350 type: object required: - run_workflows_from_fork_pull_requests @@ -18898,7 +19374,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *130 + default: *131 responses: '204': description: Empty response for successful settings update @@ -18948,7 +19424,7 @@ paths: type: array items: *66 examples: - default: &134 + default: &135 value: total_count: 1 repositories: @@ -19133,7 +19609,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *63 - - &131 + - &132 name: repository_id description: The unique identifier of the repository. in: path @@ -19162,7 +19638,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -19191,7 +19667,7 @@ paths: description: Response content: application/json: - schema: &132 + schema: &133 type: object properties: github_owned_allowed: @@ -19213,7 +19689,7 @@ paths: items: type: string examples: - default: &133 + default: &134 value: github_owned_allowed: true verified_allowed: false @@ -19246,9 +19722,9 @@ paths: required: false content: application/json: - schema: *132 + schema: *133 examples: - selected_actions: *133 + selected_actions: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19380,7 +19856,7 @@ paths: type: array items: *66 examples: - default: *134 + default: *135 '403': *29 '404': *6 x-github: @@ -19449,7 +19925,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: - *63 - - *131 + - *132 responses: '204': description: No content @@ -19476,7 +19952,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: - *63 - - *131 + - *132 responses: '204': description: No content @@ -19510,17 +19986,17 @@ paths: description: Response content: application/json: - schema: &353 + schema: &351 type: object properties: - default_workflow_permissions: &135 + default_workflow_permissions: &136 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &136 + can_approve_pull_request_reviews: &137 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -19528,7 +20004,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &137 + default: &138 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -19561,13 +20037,13 @@ paths: required: false content: application/json: - schema: &354 + schema: &352 type: object properties: - default_workflow_permissions: *135 - can_approve_pull_request_reviews: *136 + default_workflow_permissions: *136 + can_approve_pull_request_reviews: *137 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19612,7 +20088,7 @@ paths: type: number runner_groups: type: array - items: &138 + items: &139 type: object properties: id: @@ -19800,9 +20276,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: &140 + default: &141 value: id: 2 name: octo-runner-group @@ -19838,7 +20314,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *63 - - &139 + - &140 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -19850,7 +20326,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: default: value: @@ -19887,7 +20363,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *63 - - *139 + - *140 requestBody: required: true content: @@ -19941,9 +20417,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: *140 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19963,7 +20439,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *63 - - *139 + - *140 responses: '204': description: Response @@ -19987,7 +20463,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 - *17 - *19 responses: @@ -20005,9 +20481,9 @@ paths: type: number runners: type: array - items: *113 + items: *114 examples: - default: *141 + default: *142 headers: Link: *54 x-github: @@ -20030,7 +20506,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: - *63 - - *139 + - *140 - *19 - *17 responses: @@ -20048,9 +20524,9 @@ paths: type: number repositories: type: array - items: *142 + items: *143 examples: - default: &664 + default: &663 value: total_count: 1 repositories: @@ -20303,7 +20779,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: - *63 - - *139 + - *140 requestBody: required: true content: @@ -20348,8 +20824,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: - *63 - - *139 - - *131 + - *140 + - *132 responses: '204': description: Response @@ -20372,8 +20848,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: - *63 - - *139 - - *131 + - *140 + - *132 responses: '204': description: Response @@ -20397,7 +20873,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 - *17 - *19 responses: @@ -20415,7 +20891,7 @@ paths: type: number runners: type: array - items: &144 + items: &145 title: Self hosted runners description: A self hosted runner type: object @@ -20444,7 +20920,7 @@ paths: type: boolean labels: type: array - items: &147 + items: &148 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -20474,7 +20950,7 @@ paths: - busy - labels examples: - default: &145 + default: &146 value: total_count: 2 runners: @@ -20534,7 +21010,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 requestBody: required: true content: @@ -20579,8 +21055,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: - *63 - - *139 - - &143 + - *140 + - &144 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -20609,8 +21085,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: - *63 - - *139 - - *143 + - *140 + - *144 responses: '204': description: Response @@ -20658,9 +21134,9 @@ paths: type: integer runners: type: array - items: *144 + items: *145 examples: - default: *145 + default: *146 headers: Link: *54 x-github: @@ -20692,7 +21168,7 @@ paths: application/json: schema: type: array - items: &355 + items: &353 title: Runner Application description: Runner Application type: object @@ -20717,7 +21193,7 @@ paths: - download_url - filename examples: - default: &356 + default: &354 value: - os: osx architecture: x64 @@ -20803,7 +21279,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &357 + '201': &355 description: Response content: application/json: @@ -20813,7 +21289,7 @@ paths: - runner - encoded_jit_config properties: - runner: *144 + runner: *145 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -20876,7 +21352,7 @@ paths: description: Response content: application/json: - schema: &146 + schema: &147 title: Authentication Token description: Authentication Token type: object @@ -20914,7 +21390,7 @@ paths: - token - expires_at examples: - default: &358 + default: &356 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -20951,9 +21427,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: &359 + default: &357 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -20979,15 +21455,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: &360 + default: &358 value: id: 23 name: MBP @@ -21029,7 +21505,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *63 - - *143 + - *144 responses: '204': description: Response @@ -21056,9 +21532,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 responses: - '200': &148 + '200': &149 description: Response content: application/json: @@ -21072,7 +21548,7 @@ paths: type: integer labels: type: array - items: *147 + items: *148 examples: default: value: @@ -21112,7 +21588,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 requestBody: required: true content: @@ -21136,7 +21612,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21161,7 +21637,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 requestBody: required: true content: @@ -21186,7 +21662,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21211,9 +21687,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: - *63 - - *143 + - *144 responses: - '200': &361 + '200': &359 description: Response content: application/json: @@ -21227,7 +21703,7 @@ paths: type: integer labels: type: array - items: *147 + items: *148 examples: default: value: @@ -21269,8 +21745,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: - *63 - - *143 - - &362 + - *144 + - &360 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21278,7 +21754,7 @@ paths: schema: type: string responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21321,7 +21797,7 @@ paths: type: integer secrets: type: array - items: &149 + items: &150 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21400,7 +21876,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &372 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21429,7 +21905,7 @@ paths: - key_id - key examples: - default: &375 + default: &373 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21455,7 +21931,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *63 - - &150 + - &151 name: secret_name description: The name of the secret. in: path @@ -21467,7 +21943,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: default: value: @@ -21498,7 +21974,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -21555,7 +22031,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -21582,7 +22058,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -21609,7 +22085,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -21627,9 +22103,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: &154 + default: &155 value: total_count: 1 repositories: @@ -21722,7 +22198,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -21775,7 +22251,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -21809,7 +22285,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -21842,7 +22318,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *63 - - &343 + - &341 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)." @@ -21866,7 +22342,7 @@ paths: type: integer variables: type: array - items: &152 + items: &153 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -21999,7 +22475,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -22025,7 +22501,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *63 - - &153 + - &154 name: name description: The name of the variable. in: path @@ -22037,7 +22513,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *153 examples: default: value: @@ -22068,7 +22544,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *63 - - *153 + - *154 requestBody: required: true content: @@ -22131,7 +22607,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *63 - - *153 + - *154 responses: '204': description: Response @@ -22158,7 +22634,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *63 - - *153 + - *154 - *19 - *17 responses: @@ -22176,9 +22652,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22205,7 +22681,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *63 - - *153 + - *154 requestBody: required: true content: @@ -22255,7 +22731,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *63 - - *153 + - *154 - name: repository_id in: path required: true @@ -22290,7 +22766,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *63 - - *153 + - *154 - name: repository_id in: path required: true @@ -22575,12 +23051,12 @@ paths: required: - subject_digests examples: - default: &692 + default: &691 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &693 + withPredicateType: &692 value: subject_digests: - sha256:abc123 @@ -22638,7 +23114,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &694 + default: &693 value: attestations_subject_digests: - sha256:abc: @@ -22987,7 +23463,7 @@ paths: initiator: type: string examples: - default: &388 + default: &386 value: attestations: - bundle: @@ -23206,7 +23682,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &155 + schema: &156 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -23232,7 +23708,7 @@ paths: application/json: schema: type: array - items: &156 + items: &157 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -23263,7 +23739,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &178 + items: &179 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -23338,7 +23814,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &231 + properties: &232 id: description: Unique identifier of the team type: integer @@ -23410,7 +23886,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &232 + required: &233 - id - node_id - url @@ -23453,7 +23929,7 @@ paths: type: string format: date-time nullable: true - state: *155 + state: *156 contact_link: description: The contact link of the campaign. type: string @@ -23673,9 +24149,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: &157 + default: &158 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -23758,9 +24234,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: *157 + default: *158 '404': *6 '422': description: Unprocessable Entity @@ -23837,7 +24313,7 @@ paths: type: string format: uri nullable: true - state: *155 + state: *156 examples: default: value: @@ -23847,9 +24323,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: *157 + default: *158 '400': description: Bad Request content: @@ -23916,17 +24392,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *63 - - &414 + - &412 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: &165 + schema: &166 type: string description: The name of the tool used to generate the code scanning analysis. - - &415 + - &413 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 @@ -23934,7 +24410,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &166 + schema: &167 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -23949,7 +24425,7 @@ paths: be returned. in: query required: false - schema: &417 + schema: &415 type: string description: State of a code scanning alert. enum: @@ -23972,7 +24448,7 @@ paths: be returned. in: query required: false - schema: &418 + schema: &416 type: string description: Severity of a code scanning alert. enum: @@ -23993,18 +24469,18 @@ paths: items: type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: &419 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: &417 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &167 + state: &168 type: string description: State of a code scanning alert. nullable: true @@ -24012,7 +24488,7 @@ paths: - open - dismissed - fixed - fixed_at: *163 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -24020,8 +24496,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: &420 + dismissed_at: *165 + dismissed_reason: &418 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24030,13 +24506,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &421 + dismissed_comment: &419 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &422 + rule: &420 type: object properties: id: @@ -24089,25 +24565,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &423 + tool: &421 type: object properties: - name: *165 + name: *166 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *166 - most_recent_instance: &424 + guid: *167 + most_recent_instance: &422 type: object properties: - ref: &416 + ref: &414 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &434 + analysis_key: &432 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24118,13 +24594,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &435 + category: &433 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: *167 + state: *168 commit_sha: type: string message: @@ -24631,7 +25107,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *168 + code_scanning_options: *169 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -24774,7 +25250,7 @@ paths: application/json: schema: *43 examples: - default: *169 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24802,9 +25278,9 @@ paths: description: Response content: application/json: - schema: *170 + schema: *171 examples: - default: *171 + default: *172 '304': *37 '403': *29 '404': *6 @@ -24856,7 +25332,7 @@ paths: - 32 - 91 responses: - '204': *172 + '204': *173 '400': *14 '403': *29 '404': *6 @@ -24891,7 +25367,7 @@ paths: application/json: schema: *43 examples: - default: *169 + default: *170 '304': *37 '403': *29 '404': *6 @@ -25175,7 +25651,7 @@ paths: - *63 - *45 responses: - '204': *172 + '204': *173 '400': *14 '403': *29 '404': *6 @@ -25313,7 +25789,7 @@ paths: default: value: default_for_new_repos: all - configuration: *169 + configuration: *170 '403': *29 '404': *6 x-github: @@ -25366,13 +25842,13 @@ paths: application/json: schema: type: array - items: *173 + items: *174 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *174 + repository: *175 '403': *29 '404': *6 x-github: @@ -25412,7 +25888,7 @@ paths: type: integer codespaces: type: array - items: &221 + items: &222 type: object title: Codespace description: A codespace. @@ -25437,12 +25913,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *142 + repository: *143 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &447 + properties: &445 name: type: string description: The name of the machine. @@ -25484,7 +25960,7 @@ paths: - ready - in_progress nullable: true - required: &448 + required: &446 - name - display_name - operating_system @@ -25689,7 +26165,7 @@ paths: - pulls_url - recent_folders examples: - default: &222 + default: &223 value: total_count: 3 codespaces: @@ -26313,7 +26789,7 @@ paths: type: integer secrets: type: array - items: &175 + items: &176 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26352,7 +26828,7 @@ paths: - updated_at - visibility examples: - default: &449 + default: &447 value: total_count: 2 secrets: @@ -26390,7 +26866,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &448 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26419,7 +26895,7 @@ paths: - key_id - key examples: - default: &451 + default: &449 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26443,15 +26919,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *175 + schema: *176 examples: - default: &453 + default: &451 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26479,7 +26955,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -26534,7 +27010,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -26561,7 +27037,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -26587,7 +27063,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -26605,9 +27081,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 '404': *6 x-github: githubCloudOnly: false @@ -26630,7 +27106,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -26681,7 +27157,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -26715,7 +27191,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -26918,7 +27394,7 @@ paths: currently being billed. seats: type: array - items: &224 + items: &225 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -26935,14 +27411,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *176 - required: *177 + properties: *177 + required: *178 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *178 + - *179 - *55 nullable: true pending_cancellation_date: @@ -27886,11 +28362,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *63 - - *179 - *180 - *181 - *182 - *183 + - *184 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -27928,8 +28404,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *184 - *185 + - *186 - *48 - *40 - *41 @@ -27941,9 +28417,9 @@ paths: application/json: schema: type: array - items: *186 + items: *187 examples: - default: *187 + default: *188 '304': *37 '400': *14 '403': *29 @@ -27987,7 +28463,7 @@ paths: type: integer secrets: type: array - items: &188 + items: &189 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28064,7 +28540,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &477 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28081,7 +28557,7 @@ paths: - key_id - key examples: - default: &480 + default: &478 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28105,13 +28581,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *188 + schema: *189 examples: default: value: @@ -28140,7 +28616,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -28199,7 +28675,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -28224,7 +28700,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -28249,7 +28725,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -28267,9 +28743,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28291,7 +28767,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -28342,7 +28818,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -28374,7 +28850,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -28412,7 +28888,7 @@ paths: application/json: schema: type: array - items: &234 + items: &235 title: Package description: A software package type: object @@ -28462,8 +28938,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *189 - required: *190 + properties: *190 + required: *191 nullable: true created_at: type: string @@ -28482,7 +28958,7 @@ paths: - created_at - updated_at examples: - default: &235 + default: &236 value: - id: 197 name: hello_docker @@ -28652,7 +29128,7 @@ paths: application/json: schema: type: array - items: &213 + items: &214 title: Organization Invitation description: Organization Invitation type: object @@ -28699,7 +29175,7 @@ paths: - invitation_teams_url - node_id examples: - default: &214 + default: &215 value: - id: 1 login: monalisa @@ -28766,7 +29242,7 @@ paths: application/json: schema: type: array - items: &191 + items: &192 title: Org Hook description: Org Hook type: object @@ -28937,9 +29413,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: - default: &192 + default: &193 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28987,7 +29463,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *63 - - &193 + - &194 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. @@ -29000,9 +29476,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: - default: *192 + default: *193 '404': *6 x-github: githubCloudOnly: false @@ -29030,7 +29506,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *63 - - *193 + - *194 requestBody: required: false content: @@ -29075,7 +29551,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: default: value: @@ -29117,7 +29593,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *63 - - *193 + - *194 responses: '204': description: Response @@ -29145,7 +29621,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *63 - - *193 + - *194 responses: '200': description: Response @@ -29176,7 +29652,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *63 - - *193 + - *194 requestBody: required: false content: @@ -29227,9 +29703,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *63 - - *193 - - *17 - *194 + - *17 + - *195 responses: '200': description: Response @@ -29237,9 +29713,9 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '400': *14 '422': *15 x-github: @@ -29265,16 +29741,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *63 - - *193 + - *194 - *16 responses: '200': description: Response content: application/json: - schema: *197 + schema: *198 examples: - default: *198 + default: *199 '400': *14 '422': *15 x-github: @@ -29300,7 +29776,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *63 - - *193 + - *194 - *16 responses: '202': *39 @@ -29330,7 +29806,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *63 - - *193 + - *194 responses: '204': description: Response @@ -29353,7 +29829,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *63 - - &203 + - &204 name: actor_type in: path description: The type of the actor @@ -29366,14 +29842,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &204 + - &205 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &199 + - &200 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`.' @@ -29381,7 +29857,7 @@ paths: required: true schema: type: string - - &200 + - &201 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) @@ -29475,12 +29951,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *63 - - *199 - *200 + - *201 - *19 - *17 - *48 - - &209 + - &210 name: sort description: The property to sort the results by. in: query @@ -29559,14 +30035,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *63 - - *199 - *200 + - *201 responses: '200': description: Response content: application/json: - schema: &201 + schema: &202 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -29582,7 +30058,7 @@ paths: type: integer format: int64 examples: - default: &202 + default: &203 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -29603,23 +30079,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *63 - - &205 + - &206 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *199 - *200 + - *201 responses: '200': description: Response content: application/json: - schema: *201 + schema: *202 examples: - default: *202 + default: *203 x-github: enabledForGitHubApps: true category: orgs @@ -29638,18 +30114,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *63 - - *199 - *200 - - *203 + - *201 - *204 + - *205 responses: '200': description: Response content: application/json: - schema: *201 + schema: *202 examples: - default: *202 + default: *203 x-github: enabledForGitHubApps: true category: orgs @@ -29667,9 +30143,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *63 - - *199 - *200 - - &206 + - *201 + - &207 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -29682,7 +30158,7 @@ paths: description: Response content: application/json: - schema: &207 + schema: &208 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -29698,7 +30174,7 @@ paths: type: integer format: int64 examples: - default: &208 + default: &209 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -29735,18 +30211,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *63 - - *205 - - *199 - - *200 - *206 + - *200 + - *201 + - *207 responses: '200': description: Response content: application/json: - schema: *207 + schema: *208 examples: - default: *208 + default: *209 x-github: enabledForGitHubApps: true category: orgs @@ -29764,19 +30240,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *63 - - *203 - *204 - - *199 + - *205 - *200 - - *206 + - *201 + - *207 responses: '200': description: Response content: application/json: - schema: *207 + schema: *208 examples: - default: *208 + default: *209 x-github: enabledForGitHubApps: true category: orgs @@ -29794,13 +30270,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *63 - - *205 - - *199 + - *206 - *200 + - *201 - *19 - *17 - *48 - - *209 + - *210 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -29881,7 +30357,7 @@ paths: application/json: schema: *22 examples: - default: &518 + default: &516 value: id: 1 account: @@ -30047,12 +30523,12 @@ paths: application/json: schema: anyOf: - - &211 + - &212 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &210 + limit: &211 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30077,7 +30553,7 @@ paths: properties: {} additionalProperties: false examples: - default: &212 + default: &213 value: limit: collaborators_only origin: organization @@ -30106,13 +30582,13 @@ paths: required: true content: application/json: - schema: &519 + schema: &517 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *210 + limit: *211 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30136,9 +30612,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 + default: *213 '422': *15 x-github: githubCloudOnly: false @@ -30214,9 +30690,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 '404': *6 @@ -30293,7 +30769,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *214 examples: default: value: @@ -30348,7 +30824,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *63 - - &215 + - &216 name: invitation_id description: The unique identifier of the invitation. in: path @@ -30379,7 +30855,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *63 - - *215 + - *216 - *17 - *19 responses: @@ -30389,9 +30865,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: &233 + default: &234 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -30434,7 +30910,7 @@ paths: application/json: schema: type: array - items: *216 + items: *217 examples: default: value: @@ -30519,9 +30995,9 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: - default: &217 + default: &218 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -30554,7 +31030,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *63 - - &218 + - &219 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -30607,9 +31083,9 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: - default: *217 + default: *218 '404': *6 '422': *7 x-github: @@ -30634,7 +31110,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *63 - - *218 + - *219 responses: '204': description: Response @@ -30697,7 +31173,7 @@ paths: - closed - all default: open - - *219 + - *220 - name: type description: Can be the name of an issue type. in: query @@ -30728,7 +31204,7 @@ paths: type: array items: *82 examples: - default: *220 + default: *221 headers: Link: *54 '404': *6 @@ -30887,9 +31363,9 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: - default: *222 + default: *223 '304': *37 '500': *103 '401': *25 @@ -30916,7 +31392,7 @@ paths: parameters: - *63 - *59 - - &223 + - &224 name: codespace_name in: path required: true @@ -30951,15 +31427,15 @@ paths: parameters: - *63 - *59 - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: &446 + default: &444 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31139,7 +31615,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *224 + schema: *225 examples: default: value: @@ -31215,7 +31691,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &226 title: Org Membership description: Org Membership type: object @@ -31282,7 +31758,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &226 + response-if-user-has-an-active-admin-membership-with-organization: &227 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31379,9 +31855,9 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: - response-if-user-already-had-membership-with-organization: *226 + response-if-user-already-had-membership-with-organization: *227 '422': *15 '403': *29 x-github: @@ -31452,7 +31928,7 @@ paths: application/json: schema: type: array - items: &227 + items: &228 title: Migration description: A migration. type: object @@ -31781,7 +32257,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -31960,7 +32436,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *63 - - &228 + - &229 name: migration_id description: The unique identifier of the migration. in: path @@ -31987,7 +32463,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -32157,7 +32633,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *63 - - *228 + - *229 responses: '302': description: Response @@ -32179,7 +32655,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *63 - - *228 + - *229 responses: '204': description: Response @@ -32203,8 +32679,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *63 - - *228 - - &677 + - *229 + - &676 name: repo_name description: repo_name parameter in: path @@ -32232,7 +32708,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *63 - - *228 + - *229 - *17 - *19 responses: @@ -32242,9 +32718,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: &240 + default: &241 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32397,7 +32873,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &230 + items: &231 title: Organization Role description: Organization roles type: object @@ -32572,7 +33048,7 @@ paths: parameters: - *63 - *64 - - &229 + - &230 name: role_id description: The unique identifier of the role. in: path @@ -32609,7 +33085,7 @@ paths: parameters: - *63 - *64 - - *229 + - *230 responses: '204': description: Response @@ -32662,7 +33138,7 @@ paths: parameters: - *63 - *59 - - *229 + - *230 responses: '204': description: Response @@ -32694,7 +33170,7 @@ paths: parameters: - *63 - *59 - - *229 + - *230 responses: '204': description: Response @@ -32723,13 +33199,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *63 - - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *230 + schema: *231 examples: default: value: @@ -32780,7 +33256,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *63 - - *229 + - *230 - *17 - *19 responses: @@ -32858,8 +33334,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 nullable: true type: description: The ownership type of the team @@ -32891,7 +33367,7 @@ paths: - type - parent examples: - default: *233 + default: *234 headers: Link: *54 '404': @@ -32921,7 +33397,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *63 - - *229 + - *230 - *17 - *19 responses: @@ -32954,8 +33430,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 name: nullable: true type: string @@ -33243,7 +33719,7 @@ paths: - nuget - container - *63 - - &678 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -33279,12 +33755,12 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *235 + default: *236 '403': *29 '401': *25 - '400': &680 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -33306,7 +33782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &236 + - &237 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 @@ -33324,7 +33800,7 @@ paths: - docker - nuget - container - - &237 + - &238 name: package_name description: The name of the package. in: path @@ -33337,7 +33813,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *235 examples: default: value: @@ -33389,8 +33865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *236 - *237 + - *238 - *63 responses: '204': @@ -33423,8 +33899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - name: token description: package token @@ -33457,8 +33933,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: - - *236 - *237 + - *238 - *63 - *19 - *17 @@ -33479,7 +33955,7 @@ paths: application/json: schema: type: array - items: &238 + items: &239 title: Package Version description: A version of a software package type: object @@ -33604,10 +34080,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - &239 + - &240 name: package_version_id description: Unique identifier of the package version. in: path @@ -33619,7 +34095,7 @@ paths: description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -33655,10 +34131,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - *239 + - *240 responses: '204': description: Response @@ -33690,10 +34166,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - *239 + - *240 responses: '204': description: Response @@ -33723,7 +34199,7 @@ paths: - *63 - *17 - *19 - - &241 + - &242 name: sort description: The property by which to sort the results. in: query @@ -33734,7 +34210,7 @@ paths: - created_at default: created_at - *48 - - &242 + - &243 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -33745,7 +34221,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &243 + - &244 name: repository description: The name of the repository to use to filter the results. in: query @@ -33753,7 +34229,7 @@ paths: schema: type: string example: Hello-World - - &244 + - &245 name: permission description: The permission to use to filter the results. in: query @@ -33761,7 +34237,7 @@ paths: schema: type: string example: issues_read - - &245 + - &246 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) @@ -33771,7 +34247,7 @@ paths: schema: type: string format: date-time - - &246 + - &247 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) @@ -33781,7 +34257,7 @@ paths: schema: type: string format: date-time - - &247 + - &248 name: token_id description: The ID of the token in: query @@ -34051,7 +34527,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34092,9 +34568,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -34120,14 +34596,14 @@ paths: - *63 - *17 - *19 - - *241 - - *48 - *242 + - *48 - *243 - *244 - *245 - *246 - *247 + - *248 responses: '500': *103 '422': *15 @@ -34366,7 +34842,7 @@ paths: responses: '500': *103 '404': *6 - '204': *172 + '204': *173 '403': *29 '422': *15 x-github: @@ -34407,9 +34883,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -34451,7 +34927,7 @@ paths: type: integer configurations: type: array - items: &248 + items: &249 title: Organization private registry description: Private registry configuration for an organization type: object @@ -34741,7 +35217,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &249 + org-private-registry-with-selected-visibility: &250 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -34831,15 +35307,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *248 + schema: *249 examples: - default: *249 + default: *250 '404': *6 x-github: githubCloudOnly: false @@ -34861,7 +35337,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -34966,7 +35442,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -34977,266 +35453,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: - - *63 - - 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: &250 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week - in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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: *54 - '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: - - *63 - 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: *250 - 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': *25 - '403': *29 - '404': *6 - '410': &330 - 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 @@ -35336,7 +35552,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &761 + properties: &760 id: type: number description: The unique identifier of the status update. @@ -35384,7 +35600,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &762 + required: &761 - id - node_id - created_at @@ -35708,7 +35924,7 @@ paths: - updated_at - project_url examples: - default: &697 + default: &696 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -35812,7 +36028,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *253 - - &698 + - &697 name: field_id description: The unique identifier of the field. in: path @@ -35827,7 +36043,7 @@ paths: application/json: schema: *254 examples: - default: &699 + default: &698 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36702,7 +36918,7 @@ paths: description: Response content: application/json: - schema: &700 + schema: &699 title: Projects v2 Item description: An item belonging to a project type: object @@ -36716,7 +36932,7 @@ paths: content: oneOf: - *82 - - &461 + - &459 title: Pull Request Simple description: Pull Request Simple type: object @@ -36868,7 +37084,7 @@ paths: nullable: true requested_teams: type: array - items: *178 + items: *179 nullable: true head: type: object @@ -36945,7 +37161,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: &566 + auto_merge: &565 title: Auto merge description: The status of auto merging a pull request. type: object @@ -37663,7 +37879,7 @@ paths: - *63 - *265 responses: - '204': *172 + '204': *173 '403': *29 '404': *6 x-github: @@ -37981,9 +38197,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -38185,7 +38401,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &330 title: Full Repository description: Full Repository type: object @@ -38578,7 +38794,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &466 + properties: &464 url: type: string format: uri @@ -38594,7 +38810,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &467 + required: &465 - url - key - name @@ -38683,7 +38899,7 @@ paths: - network_count - subscribers_count examples: - default: &334 + default: &332 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39204,7 +39420,7 @@ paths: - *63 - *17 - *19 - - &589 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -39485,7 +39701,7 @@ paths: - repository_property rules: type: array - items: &590 + items: &589 title: Repository Rule type: object description: A repository rule. @@ -39547,7 +39763,7 @@ paths: type: string enum: - required_linear_history - - &587 + - &586 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40171,7 +40387,7 @@ paths: - tool required: - code_scanning_tools - - &588 + - &587 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -40397,7 +40613,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *63 - - &591 + - &590 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -40412,7 +40628,7 @@ paths: in: query schema: type: string - - &592 + - &591 name: time_period description: |- The time period to filter by. @@ -40428,14 +40644,14 @@ paths: - week - month default: day - - &593 + - &592 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &594 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -40455,7 +40671,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &594 title: Rule Suites description: Response type: array @@ -40510,7 +40726,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &596 + default: &595 value: - id: 21 actor_id: 12 @@ -40554,7 +40770,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *63 - - &597 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -40570,7 +40786,7 @@ paths: description: Response content: application/json: - schema: &598 + schema: &597 title: Rule Suite description: Response type: object @@ -40669,7 +40885,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &599 + default: &598 value: id: 21 actor_id: 12 @@ -40915,7 +41131,7 @@ paths: type: string format: date-time examples: - default: &601 + default: &600 value: - version_id: 3 actor: @@ -40968,7 +41184,7 @@ paths: description: Response content: application/json: - schema: &602 + schema: &601 allOf: - *298 - type: object @@ -41040,7 +41256,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *63 - - &603 + - &602 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41051,7 +41267,7 @@ paths: enum: - open - resolved - - &604 + - &603 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41061,7 +41277,7 @@ paths: required: false schema: type: string - - &605 + - &604 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41070,7 +41286,7 @@ paths: required: false schema: type: string - - &606 + - &605 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -41085,7 +41301,7 @@ paths: - *48 - *19 - *17 - - &607 + - &606 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -41095,7 +41311,7 @@ paths: required: false schema: type: string - - &608 + - &607 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -41105,7 +41321,7 @@ paths: required: false schema: type: string - - &609 + - &608 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41114,7 +41330,7 @@ paths: required: false schema: type: string - - &610 + - &609 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41123,7 +41339,7 @@ paths: schema: type: boolean default: false - - &611 + - &610 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41132,7 +41348,7 @@ paths: schema: type: boolean default: false - - &612 + - &611 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41151,8 +41367,8 @@ paths: items: type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -41160,21 +41376,21 @@ paths: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &613 + state: &612 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &614 + resolution: &613 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -41281,8 +41497,8 @@ paths: pull request. ' - oneOf: &615 - - &617 + oneOf: &614 + - &616 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -41334,7 +41550,7 @@ paths: - blob_url - commit_sha - commit_url - - &618 + - &617 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -41389,7 +41605,7 @@ paths: - page_url - commit_sha - commit_url - - &619 + - &618 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -41403,7 +41619,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &620 + - &619 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -41417,7 +41633,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &621 + - &620 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -41431,7 +41647,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &622 + - &621 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -41445,7 +41661,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &623 + - &622 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -41459,7 +41675,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &624 + - &623 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -41473,7 +41689,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &625 + - &624 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -41487,7 +41703,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &626 + - &625 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -41501,7 +41717,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &627 + - &626 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -41515,7 +41731,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &628 + - &627 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -41529,7 +41745,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &629 + - &628 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -42027,7 +42243,7 @@ paths: application/json: schema: type: array - items: &633 + items: &632 description: A repository security advisory. type: object properties: @@ -42281,7 +42497,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *178 + items: *179 private_fork: readOnly: true nullable: true @@ -42318,7 +42534,7 @@ paths: - private_fork additionalProperties: false examples: - default: &634 + default: &633 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -42707,7 +42923,7 @@ paths: type: array items: *302 examples: - default: *233 + default: *234 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42792,7 +43008,7 @@ paths: description: Response content: application/json: - schema: &701 + schema: &700 type: object properties: total_minutes_used: @@ -42862,7 +43078,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &702 + default: &701 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -42898,7 +43114,7 @@ paths: description: Response content: application/json: - schema: &703 + schema: &702 type: object properties: total_gigabytes_bandwidth_used: @@ -42916,7 +43132,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &704 + default: &703 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -42948,7 +43164,7 @@ paths: description: Response content: application/json: - schema: &706 + schema: &705 type: object properties: days_left_in_billing_cycle: @@ -42966,7 +43182,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &707 + default: &706 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -43114,9 +43330,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43185,7 +43401,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -43208,7 +43424,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -43671,9 +43887,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 headers: Link: *54 '403': *29 @@ -43830,8 +44046,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 nullable: true members_count: type: integer @@ -44435,7 +44651,7 @@ paths: - updated_at - url examples: - default: &651 + default: &650 value: - author: login: octocat @@ -44683,7 +44899,7 @@ paths: application/json: schema: *311 examples: - default: &652 + default: &651 value: author: login: octocat @@ -44866,7 +45082,7 @@ paths: - updated_at - url examples: - default: &653 + default: &652 value: - author: login: octocat @@ -45092,7 +45308,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &653 value: author: login: octocat @@ -45595,9 +45811,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 x-github: @@ -45708,7 +45924,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &655 + response-if-user-is-a-team-maintainer: &654 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -45773,7 +45989,7 @@ paths: application/json: schema: *321 examples: - response-if-users-membership-with-team-is-now-pending: &656 + response-if-users-membership-with-team-is-now-pending: &655 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -45914,7 +46130,7 @@ paths: - updated_at - permissions examples: - default: &657 + default: &656 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -45993,7 +46209,7 @@ paths: application/json: schema: *322 examples: - default: &658 + default: &657 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46163,9 +46379,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -46203,7 +46419,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &659 + schema: &658 title: Team Repository description: A team's access to a repository. type: object @@ -46858,9 +47074,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - response-if-child-teams-exist: &660 + response-if-child-teams-exist: &659 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47206,208 +47422,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: - - *323 - responses: - '200': - description: Response - content: - application/json: - schema: *250 - examples: - default: &329 - 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': *37 - '403': *29 - '401': *25 - 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: - - *323 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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: *250 - examples: - default: *329 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *330 - '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: - - *323 - responses: - '204': - description: Delete Success - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *330 - '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 @@ -47665,7 +47679,7 @@ paths: resources: type: object properties: - core: &331 + core: &329 title: Rate Limit type: object properties: @@ -47682,21 +47696,21 @@ paths: - remaining - reset - used - graphql: *331 - search: *331 - code_search: *331 - source_import: *331 - integration_manifest: *331 - code_scanning_upload: *331 - actions_runner_registration: *331 - scim: *331 - dependency_snapshots: *331 - dependency_sbom: *331 - code_scanning_autofix: *331 + graphql: *329 + search: *329 + code_search: *329 + source_import: *329 + integration_manifest: *329 + code_scanning_upload: *329 + actions_runner_registration: *329 + scim: *329 + dependency_snapshots: *329 + dependency_sbom: *329 + code_scanning_autofix: *329 required: - core - search - rate: *331 + rate: *329 required: - rate - resources @@ -47808,7 +47822,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: default-response: summary: Default response @@ -48309,7 +48323,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *333 + '301': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48575,10 +48589,10 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 - '307': &335 + default: *332 + '307': &333 description: Temporary Redirect content: application/json: @@ -48630,7 +48644,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *335 + '307': *333 '404': *6 '409': *47 x-github: @@ -48658,7 +48672,7 @@ paths: - *325 - *17 - *19 - - &366 + - &364 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -48681,7 +48695,7 @@ paths: type: integer artifacts: type: array - items: &336 + items: &334 title: Artifact description: An artifact type: object @@ -48759,7 +48773,7 @@ paths: - expires_at - updated_at examples: - default: &367 + default: &365 value: total_count: 2 artifacts: @@ -48822,7 +48836,7 @@ paths: parameters: - *324 - *325 - - &337 + - &335 name: artifact_id description: The unique identifier of the artifact. in: path @@ -48834,7 +48848,7 @@ paths: description: Response content: application/json: - schema: *336 + schema: *334 examples: default: value: @@ -48874,7 +48888,7 @@ paths: parameters: - *324 - *325 - - *337 + - *335 responses: '204': description: Response @@ -48900,7 +48914,7 @@ paths: parameters: - *324 - *325 - - *337 + - *335 - name: archive_format in: path required: true @@ -48914,7 +48928,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': *330 + '410': &520 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48944,7 +48962,7 @@ paths: description: Response content: application/json: - schema: *338 + schema: *336 examples: default: value: @@ -48974,7 +48992,7 @@ paths: - *325 - *17 - *19 - - &339 + - &337 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 @@ -49008,7 +49026,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &338 title: Repository actions caches description: Repository actions caches type: object @@ -49050,7 +49068,7 @@ paths: - total_count - actions_caches examples: - default: &341 + default: &339 value: total_count: 1 actions_caches: @@ -49090,15 +49108,15 @@ paths: required: true schema: type: string - - *339 + - *337 responses: '200': description: Response content: application/json: - schema: *340 + schema: *338 examples: - default: *341 + default: *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49152,7 +49170,7 @@ paths: parameters: - *324 - *325 - - &342 + - &340 name: job_id description: The unique identifier of the job. in: path @@ -49164,7 +49182,7 @@ paths: description: Response content: application/json: - schema: &370 + schema: &368 title: Job description: Information of a job execution in a workflow run type: object @@ -49473,7 +49491,7 @@ paths: parameters: - *324 - *325 - - *342 + - *340 responses: '302': description: Response @@ -49503,7 +49521,7 @@ paths: parameters: - *324 - *325 - - *342 + - *340 requestBody: required: false content: @@ -49524,7 +49542,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -49634,7 +49652,7 @@ paths: description: Empty response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -49682,7 +49700,7 @@ paths: type: integer secrets: type: array - items: &372 + items: &370 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -49702,7 +49720,7 @@ paths: - created_at - updated_at examples: - default: &373 + default: &371 value: total_count: 2 secrets: @@ -49737,7 +49755,7 @@ paths: parameters: - *324 - *325 - - *343 + - *341 - *19 responses: '200': @@ -49754,7 +49772,7 @@ paths: type: integer variables: type: array - items: &376 + items: &374 title: Actions Variable type: object properties: @@ -49784,7 +49802,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &375 value: total_count: 2 variables: @@ -49827,12 +49845,12 @@ paths: schema: type: object properties: - enabled: &345 + enabled: &343 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *127 - selected_actions_url: *344 - sha_pinning_required: *128 + allowed_actions: *128 + selected_actions_url: *342 + sha_pinning_required: *129 required: - enabled examples: @@ -49872,9 +49890,9 @@ paths: schema: type: object properties: - enabled: *345 - allowed_actions: *127 - sha_pinning_required: *128 + enabled: *343 + allowed_actions: *128 + sha_pinning_required: *129 required: - enabled examples: @@ -49911,7 +49929,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &344 type: object properties: access_level: @@ -49928,7 +49946,7 @@ paths: required: - access_level examples: - default: &347 + default: &345 value: access_level: organization x-github: @@ -49958,9 +49976,9 @@ paths: required: true content: application/json: - schema: *346 + schema: *344 examples: - default: *347 + default: *345 responses: '204': description: Response @@ -49991,7 +50009,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *346 examples: default: value: @@ -50026,7 +50044,7 @@ paths: required: true content: application/json: - schema: *349 + schema: *347 examples: default: summary: Set retention days @@ -50057,9 +50075,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *130 examples: - default: *350 + default: *348 '404': *6 x-github: enabledForGitHubApps: true @@ -50089,7 +50107,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *130 examples: default: summary: Set approval policy to first time contributors @@ -50120,9 +50138,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *349 examples: - default: *130 + default: *131 '403': *29 '404': *6 x-github: @@ -50148,9 +50166,9 @@ paths: required: true content: application/json: - schema: *352 + schema: *350 examples: - default: *130 + default: *131 responses: '204': description: Empty response for successful settings update @@ -50181,9 +50199,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *133 examples: - default: *133 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50211,9 +50229,9 @@ paths: required: false content: application/json: - schema: *132 + schema: *133 examples: - selected_actions: *133 + selected_actions: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50242,9 +50260,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *351 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50277,9 +50295,9 @@ paths: required: true content: application/json: - schema: *354 + schema: *352 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50325,9 +50343,9 @@ paths: type: integer runners: type: array - items: *144 + items: *145 examples: - default: *145 + default: *146 headers: Link: *54 x-github: @@ -50360,9 +50378,9 @@ paths: application/json: schema: type: array - items: *355 + items: *353 examples: - default: *356 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50428,7 +50446,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *357 + '201': *355 '404': *6 '422': *7 '409': *47 @@ -50466,9 +50484,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: *358 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50503,9 +50521,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50529,15 +50547,15 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *360 + default: *358 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50560,7 +50578,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: '204': description: Response @@ -50588,9 +50606,9 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: - '200': *148 + '200': *149 '404': *6 x-github: githubCloudOnly: false @@ -50614,7 +50632,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 requestBody: required: true content: @@ -50638,7 +50656,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50664,7 +50682,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 requestBody: required: true content: @@ -50689,7 +50707,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50715,9 +50733,9 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: - '200': *361 + '200': *359 '404': *6 x-github: githubCloudOnly: false @@ -50746,10 +50764,10 @@ paths: parameters: - *324 - *325 - - *143 - - *362 + - *144 + - *360 responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50777,7 +50795,7 @@ paths: parameters: - *324 - *325 - - &380 + - &378 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. @@ -50785,7 +50803,7 @@ paths: required: false schema: type: string - - &381 + - &379 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -50793,7 +50811,7 @@ paths: required: false schema: type: string - - &382 + - &380 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -50802,7 +50820,7 @@ paths: required: false schema: type: string - - &383 + - &381 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 @@ -50829,7 +50847,7 @@ paths: - pending - *17 - *19 - - &384 + - &382 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)." @@ -50838,7 +50856,7 @@ paths: schema: type: string format: date-time - - &363 + - &361 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -50847,13 +50865,13 @@ paths: schema: type: boolean default: false - - &385 + - &383 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &386 + - &384 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -50876,7 +50894,7 @@ paths: type: integer workflow_runs: type: array - items: &364 + items: &362 title: Workflow Run description: An invocation of a workflow type: object @@ -50971,7 +50989,7 @@ paths: that triggered the run. type: array nullable: true - items: &405 + items: &403 title: Pull Request Minimal type: object properties: @@ -51090,7 +51108,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &409 + properties: &407 id: type: string description: SHA for the commit @@ -51141,7 +51159,7 @@ paths: - name - email nullable: true - required: &410 + required: &408 - id - tree_id - message @@ -51149,8 +51167,8 @@ paths: - author - committer nullable: true - repository: *142 - head_repository: *142 + repository: *143 + head_repository: *143 head_repository_id: type: integer example: 5 @@ -51188,7 +51206,7 @@ paths: - workflow_url - pull_requests examples: - default: &387 + default: &385 value: total_count: 1 workflow_runs: @@ -51426,22 +51444,22 @@ paths: parameters: - *324 - *325 - - &365 + - &363 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *363 + - *361 responses: '200': description: Response content: application/json: - schema: *364 + schema: *362 examples: - default: &368 + default: &366 value: id: 30433642 name: Build @@ -51684,7 +51702,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '204': description: Response @@ -51709,7 +51727,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -51830,13 +51848,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -51865,10 +51883,10 @@ paths: parameters: - *324 - *325 - - *365 + - *363 - *17 - *19 - - *366 + - *364 responses: '200': description: Response @@ -51884,9 +51902,9 @@ paths: type: integer artifacts: type: array - items: *336 + items: *334 examples: - default: *367 + default: *365 headers: Link: *54 x-github: @@ -51912,23 +51930,23 @@ paths: parameters: - *324 - *325 - - *365 - - &369 + - *363 + - &367 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *363 + - *361 responses: '200': description: Response content: application/json: - schema: *364 + schema: *362 examples: - default: *368 + default: *366 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51953,8 +51971,8 @@ paths: parameters: - *324 - *325 - - *365 - - *369 + - *363 + - *367 - *17 - *19 responses: @@ -51972,9 +51990,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *368 examples: - default: &371 + default: &369 value: total_count: 1 jobs: @@ -52089,8 +52107,8 @@ paths: parameters: - *324 - *325 - - *365 - - *369 + - *363 + - *367 responses: '302': description: Response @@ -52120,13 +52138,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '202': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52155,7 +52173,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: true content: @@ -52224,13 +52242,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '202': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52259,7 +52277,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 - 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 @@ -52289,9 +52307,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *368 examples: - default: *371 + default: *369 headers: Link: *54 x-github: @@ -52318,7 +52336,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '302': description: Response @@ -52347,7 +52365,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '204': description: Response @@ -52376,7 +52394,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -52436,7 +52454,7 @@ paths: items: type: object properties: - type: &488 + type: &486 type: string description: The type of reviewer. enum: @@ -52446,7 +52464,7 @@ paths: reviewer: anyOf: - *4 - - *178 + - *179 required: - environment - wait_timer @@ -52523,7 +52541,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: true content: @@ -52570,7 +52588,7 @@ paths: application/json: schema: type: array - items: &483 + items: &481 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52676,7 +52694,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &482 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -52734,7 +52752,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: false content: @@ -52755,7 +52773,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52780,7 +52798,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: false content: @@ -52801,7 +52819,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52835,7 +52853,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -52991,9 +53009,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *370 examples: - default: *373 + default: *371 headers: Link: *54 x-github: @@ -53025,9 +53043,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *372 examples: - default: *375 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53051,15 +53069,15 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *372 + schema: *370 examples: - default: &501 + default: &499 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53087,7 +53105,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -53118,7 +53136,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -53146,7 +53164,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -53173,7 +53191,7 @@ paths: parameters: - *324 - *325 - - *343 + - *341 - *19 responses: '200': @@ -53190,9 +53208,9 @@ paths: type: integer variables: type: array - items: *376 + items: *374 examples: - default: *377 + default: *375 headers: Link: *54 x-github: @@ -53243,7 +53261,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -53270,15 +53288,15 @@ paths: parameters: - *324 - *325 - - *153 + - *154 responses: '200': description: Response content: application/json: - schema: *376 + schema: *374 examples: - default: &502 + default: &500 value: name: USERNAME value: octocat @@ -53306,7 +53324,7 @@ paths: parameters: - *324 - *325 - - *153 + - *154 requestBody: required: true content: @@ -53350,7 +53368,7 @@ paths: parameters: - *324 - *325 - - *153 + - *154 responses: '204': description: Response @@ -53394,7 +53412,7 @@ paths: type: integer workflows: type: array - items: &378 + items: &376 title: Workflow description: A GitHub Actions workflow type: object @@ -53503,7 +53521,7 @@ paths: parameters: - *324 - *325 - - &379 + - &377 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53518,7 +53536,7 @@ paths: description: Response content: application/json: - schema: *378 + schema: *376 examples: default: value: @@ -53553,7 +53571,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53580,7 +53598,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53633,7 +53651,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53662,17 +53680,17 @@ paths: parameters: - *324 - *325 + - *377 + - *378 - *379 - *380 - *381 - - *382 - - *383 - *17 - *19 + - *382 + - *361 + - *383 - *384 - - *363 - - *385 - - *386 responses: '200': description: Response @@ -53688,9 +53706,9 @@ paths: type: integer workflow_runs: type: array - items: *364 + items: *362 examples: - default: *387 + default: *385 headers: Link: *54 x-github: @@ -53724,7 +53742,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '200': description: Response @@ -54196,7 +54214,7 @@ paths: initiator: type: string examples: - default: *388 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54225,7 +54243,7 @@ paths: application/json: schema: type: array - items: &389 + items: &387 title: Autolink reference description: An autolink reference. type: object @@ -54319,9 +54337,9 @@ paths: description: response content: application/json: - schema: *389 + schema: *387 examples: - default: &390 + default: &388 value: id: 1 key_prefix: TICKET- @@ -54354,7 +54372,7 @@ paths: parameters: - *324 - *325 - - &391 + - &389 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54366,9 +54384,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *387 examples: - default: *390 + default: *388 '404': *6 x-github: githubCloudOnly: false @@ -54390,7 +54408,7 @@ paths: parameters: - *324 - *325 - - *391 + - *389 responses: '204': description: Response @@ -54545,7 +54563,7 @@ paths: - url protected: type: boolean - protection: &393 + protection: &391 title: Branch Protection description: Branch Protection type: object @@ -54587,7 +54605,7 @@ paths: required: - contexts - checks - enforce_admins: &396 + enforce_admins: &394 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54602,7 +54620,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &398 + required_pull_request_reviews: &396 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54623,7 +54641,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *178 + items: *179 apps: description: The list of apps with review dismissal access. @@ -54652,7 +54670,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *178 + items: *179 apps: description: The list of apps allowed to bypass pull request requirements. @@ -54678,7 +54696,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &395 + restrictions: &393 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -54741,7 +54759,7 @@ paths: type: string teams: type: array - items: *178 + items: *179 apps: type: array items: @@ -54957,7 +54975,7 @@ paths: parameters: - *324 - *325 - - &394 + - &392 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). @@ -54971,14 +54989,14 @@ paths: description: Response content: application/json: - schema: &404 + schema: &402 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &457 + commit: &455 title: Commit description: Commit type: object @@ -55012,7 +55030,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &392 + properties: &390 name: type: string example: '"Chris Wanstrath"' @@ -55027,7 +55045,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true message: type: string @@ -55048,7 +55066,7 @@ paths: required: - sha - url - verification: &508 + verification: &506 title: Verification type: object properties: @@ -55082,12 +55100,12 @@ paths: nullable: true oneOf: - *4 - - *151 + - *152 committer: nullable: true oneOf: - *4 - - *151 + - *152 parents: type: array items: @@ -55118,7 +55136,7 @@ paths: type: integer files: type: array - items: &470 + items: &468 title: Diff Entry description: Diff Entry type: object @@ -55202,7 +55220,7 @@ paths: - self protected: type: boolean - protection: *393 + protection: *391 protection_url: type: string format: uri @@ -55309,7 +55327,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *333 + '301': *331 '404': *6 x-github: githubCloudOnly: false @@ -55333,13 +55351,13 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *393 + schema: *391 examples: default: value: @@ -55535,7 +55553,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -55790,7 +55808,7 @@ paths: url: type: string format: uri - required_status_checks: &401 + required_status_checks: &399 title: Status Check Policy description: Status Check Policy type: object @@ -55866,7 +55884,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 apps: type: array items: *5 @@ -55884,7 +55902,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 apps: type: array items: *5 @@ -55942,7 +55960,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *395 + restrictions: *393 required_conversation_resolution: type: object properties: @@ -56056,7 +56074,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56083,15 +56101,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: &397 + default: &395 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56115,15 +56133,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: *397 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56144,7 +56162,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56171,15 +56189,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *398 + schema: *396 examples: - default: &399 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56277,7 +56295,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56375,9 +56393,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *396 examples: - default: *399 + default: *397 '422': *15 x-github: githubCloudOnly: false @@ -56400,7 +56418,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56429,15 +56447,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: &400 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56462,15 +56480,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: *400 + default: *398 '404': *6 x-github: githubCloudOnly: false @@ -56492,7 +56510,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56519,15 +56537,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *401 + schema: *399 examples: - default: &402 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56555,7 +56573,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56607,9 +56625,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *399 examples: - default: *402 + default: *400 '404': *6 '422': *15 x-github: @@ -56633,7 +56651,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56659,7 +56677,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -56695,7 +56713,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56764,7 +56782,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56830,7 +56848,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: content: application/json: @@ -56898,13 +56916,13 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *395 + schema: *393 examples: default: value: @@ -56997,7 +57015,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -57022,7 +57040,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57032,7 +57050,7 @@ paths: type: array items: *5 examples: - default: &403 + default: &401 value: - id: 1 slug: octoapp @@ -57091,7 +57109,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57125,7 +57143,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57148,7 +57166,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57182,7 +57200,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57205,7 +57223,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57239,7 +57257,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57263,7 +57281,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57271,9 +57289,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '404': *6 x-github: githubCloudOnly: false @@ -57295,7 +57313,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -57331,9 +57349,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57356,7 +57374,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -57392,9 +57410,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57417,7 +57435,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: content: application/json: @@ -57452,9 +57470,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57478,7 +57496,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57514,7 +57532,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57574,7 +57592,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57634,7 +57652,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57696,7 +57714,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57718,7 +57736,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *402 examples: default: value: @@ -58114,7 +58132,7 @@ paths: description: Response content: application/json: - schema: &406 + schema: &404 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58233,8 +58251,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *405 - deployment: &719 + items: *403 + deployment: &718 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58516,7 +58534,7 @@ paths: parameters: - *324 - *325 - - &407 + - &405 name: check_run_id description: The unique identifier of the check run. in: path @@ -58528,9 +58546,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *404 examples: - default: &408 + default: &406 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58632,7 +58650,7 @@ paths: parameters: - *324 - *325 - - *407 + - *405 requestBody: required: true content: @@ -58872,9 +58890,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *404 examples: - default: *408 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58896,7 +58914,7 @@ paths: parameters: - *324 - *325 - - *407 + - *405 - *17 - *19 responses: @@ -58993,13 +59011,13 @@ paths: parameters: - *324 - *325 - - *407 + - *405 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -59060,7 +59078,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &411 + schema: &409 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59124,7 +59142,7 @@ paths: nullable: true pull_requests: type: array - items: *405 + items: *403 nullable: true app: title: GitHub app @@ -59137,7 +59155,7 @@ paths: nullable: true properties: *67 required: *68 - repository: *142 + repository: *143 created_at: type: string format: date-time @@ -59146,12 +59164,12 @@ paths: type: string format: date-time nullable: true - head_commit: &745 + head_commit: &744 title: Simple Commit description: A commit. type: object - properties: *409 - required: *410 + properties: *407 + required: *408 latest_check_runs_count: type: integer check_runs_url: @@ -59179,7 +59197,7 @@ paths: - check_runs_url - pull_requests examples: - default: &412 + default: &410 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59470,9 +59488,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59553,7 +59571,7 @@ paths: required: - app_id - setting - repository: *142 + repository: *143 examples: default: value: @@ -59803,7 +59821,7 @@ paths: parameters: - *324 - *325 - - &413 + - &411 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -59815,9 +59833,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59842,15 +59860,15 @@ paths: parameters: - *324 - *325 - - *413 - - &463 + - *411 + - &461 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &464 + - &462 name: status description: Returns check runs with the specified `status`. in: query @@ -59889,9 +59907,9 @@ paths: type: integer check_runs: type: array - items: *406 + items: *404 examples: - default: &465 + default: &463 value: total_count: 1 check_runs: @@ -59995,13 +60013,13 @@ paths: parameters: - *324 - *325 - - *413 + - *411 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -60030,19 +60048,19 @@ paths: parameters: - *324 - *325 - - *414 - - *415 + - *412 + - *413 - *19 - *17 - - &432 + - &430 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: *416 - - &433 + schema: *414 + - &431 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60067,13 +60085,13 @@ paths: be returned. in: query required: false - schema: *417 + schema: *415 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *418 + schema: *416 responses: '200': description: Response @@ -60084,14 +60102,14 @@ paths: items: type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: *419 - state: *167 - fixed_at: *163 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: *417 + state: *168 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -60099,12 +60117,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: *420 - dismissed_comment: *421 - rule: *422 - tool: *423 - most_recent_instance: *424 + dismissed_at: *165 + dismissed_reason: *418 + dismissed_comment: *419 + rule: *420 + tool: *421 + most_recent_instance: *422 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60230,7 +60248,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &425 + '403': &423 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -60259,7 +60277,7 @@ paths: parameters: - *324 - *325 - - &426 + - &424 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60267,23 +60285,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *158 + schema: *159 responses: '200': description: Response content: application/json: - schema: &427 + schema: &425 type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: *419 - state: *167 - fixed_at: *163 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: *417 + state: *168 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -60291,9 +60309,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: *420 - dismissed_comment: *421 + dismissed_at: *165 + dismissed_reason: *418 + dismissed_comment: *419 rule: type: object properties: @@ -60347,8 +60365,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *423 - most_recent_instance: *424 + tool: *421 + most_recent_instance: *422 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60447,7 +60465,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60469,7 +60487,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: true content: @@ -60484,8 +60502,8 @@ paths: enum: - open - dismissed - dismissed_reason: *420 - dismissed_comment: *421 + dismissed_reason: *418 + dismissed_comment: *419 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60504,7 +60522,7 @@ paths: description: Response content: application/json: - schema: *427 + schema: *425 examples: default: value: @@ -60580,7 +60598,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &431 + '403': &429 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -60609,13 +60627,13 @@ paths: parameters: - *324 - *325 - - *426 + - *424 responses: '200': description: Response content: application/json: - schema: &428 + schema: &426 type: object properties: status: @@ -60641,13 +60659,13 @@ paths: - description - started_at examples: - default: &429 + default: &427 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &430 + '400': &428 description: Bad Request content: application/json: @@ -60658,7 +60676,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': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60685,27 +60703,27 @@ paths: parameters: - *324 - *325 - - *426 + - *424 responses: '200': description: OK content: application/json: - schema: *428 + schema: *426 examples: - default: *429 + default: *427 '202': description: Accepted content: application/json: - schema: *428 + schema: *426 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *430 + '400': *428 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -60739,7 +60757,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: false content: @@ -60784,8 +60802,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *430 - '403': *431 + '400': *428 + '403': *429 '404': *6 '422': description: Unprocessable Entity @@ -60811,11 +60829,11 @@ paths: parameters: - *324 - *325 - - *426 + - *424 - *19 - *17 - - *432 - - *433 + - *430 + - *431 responses: '200': description: Response @@ -60823,7 +60841,7 @@ paths: application/json: schema: type: array - items: *424 + items: *422 examples: default: value: @@ -60862,7 +60880,7 @@ paths: end_column: 50 classifications: - source - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60898,23 +60916,23 @@ paths: parameters: - *324 - *325 - - *414 - - *415 + - *412 + - *413 - *19 - *17 - - *433 + - *431 - 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: *416 + schema: *414 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &436 + schema: &434 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -60935,23 +60953,23 @@ paths: application/json: schema: type: array - items: &437 + items: &435 type: object properties: - ref: *416 - commit_sha: &445 + ref: *414 + commit_sha: &443 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: *434 + analysis_key: *432 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *435 + category: *433 error: type: string example: error reading field xyz @@ -60975,8 +60993,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *436 - tool: *423 + sarif_id: *434 + tool: *421 deletable: type: boolean warning: @@ -61037,7 +61055,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61087,7 +61105,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: response: summary: application/json response @@ -61141,7 +61159,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *425 + '403': *423 '404': *6 '422': description: Response if analysis could not be processed @@ -61282,7 +61300,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': *431 + '403': *429 '404': *6 '503': *104 x-github: @@ -61313,7 +61331,7 @@ paths: application/json: schema: type: array - items: &438 + items: &436 title: CodeQL Database description: A CodeQL database. type: object @@ -61424,7 +61442,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': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61466,7 +61484,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *436 examples: default: value: @@ -61498,9 +61516,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': &472 + '302': &470 description: Found - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61533,7 +61551,7 @@ paths: responses: '204': description: Response - '403': *431 + '403': *429 '404': *6 '503': *104 x-github: @@ -61571,7 +61589,7 @@ paths: type: object additionalProperties: false properties: - language: &439 + language: &437 type: string description: The language targeted by the CodeQL query enum: @@ -61650,7 +61668,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &443 + schema: &441 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61660,7 +61678,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *439 + query_language: *437 query_pack_url: type: string description: The download url for the query pack. @@ -61707,7 +61725,7 @@ paths: items: type: object properties: - repository: &440 + repository: &438 title: Repository Identifier description: Repository Identifier type: object @@ -61743,7 +61761,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &444 + analysis_status: &442 type: string description: The new status of the CodeQL variant analysis repository task. @@ -61775,7 +61793,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &441 + access_mismatch_repos: &439 type: object properties: repository_count: @@ -61789,7 +61807,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: *440 + items: *438 required: - repository_count - repositories @@ -61811,8 +61829,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *441 - over_limit_repos: *441 + no_codeql_db_repos: *439 + over_limit_repos: *439 required: - access_mismatch_repos - not_found_repos @@ -61828,7 +61846,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &442 + value: &440 summary: Default response value: id: 1 @@ -61980,10 +61998,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *442 + value: *440 repository_lists: summary: Response for a successful variant analysis submission - value: *442 + value: *440 '404': *6 '422': description: Unable to process variant analysis submission @@ -62024,9 +62042,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *441 examples: - default: *442 + default: *440 '404': *6 '503': *104 x-github: @@ -62084,7 +62102,7 @@ paths: type: object properties: repository: *53 - analysis_status: *444 + analysis_status: *442 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62295,7 +62313,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -62384,7 +62402,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -62409,7 +62427,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *431 + '403': *429 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62489,7 +62507,7 @@ paths: schema: type: object properties: - commit_sha: *445 + commit_sha: *443 ref: type: string description: |- @@ -62547,7 +62565,7 @@ paths: schema: type: object properties: - id: *436 + id: *434 url: type: string description: The REST API URL for checking the status of the upload. @@ -62561,7 +62579,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': *431 + '403': *429 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -62631,7 +62649,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': *425 + '403': *423 '404': description: Not Found if the sarif id does not match any upload '503': *104 @@ -62713,7 +62731,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': *172 + '204': *173 '304': *37 '403': *29 '404': *6 @@ -62876,7 +62894,7 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: default: value: @@ -63238,17 +63256,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '400': *14 '401': *25 '403': *29 @@ -63378,14 +63396,14 @@ paths: type: integer machines: type: array - items: &667 + items: &666 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *447 - required: *448 + properties: *445 + required: *446 examples: - default: &668 + default: &667 value: total_count: 2 machines: @@ -63596,7 +63614,7 @@ paths: type: integer secrets: type: array - items: &452 + items: &450 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63616,7 +63634,7 @@ paths: - created_at - updated_at examples: - default: *449 + default: *447 headers: Link: *54 x-github: @@ -63646,9 +63664,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *448 examples: - default: *451 + default: *449 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63670,15 +63688,15 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *452 + schema: *450 examples: - default: *453 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63700,7 +63718,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -63728,7 +63746,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -63754,7 +63772,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -63825,7 +63843,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &454 + properties: &452 login: type: string example: octocat @@ -63918,7 +63936,7 @@ paths: user_view_type: type: string example: public - required: &455 + required: &453 - avatar_url - events_url - followers_url @@ -64068,7 +64086,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &521 + schema: &519 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64079,7 +64097,7 @@ paths: example: 42 type: integer format: int64 - repository: *142 + repository: *143 invitee: title: Simple User description: A GitHub user. @@ -64257,7 +64275,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *111 + schema: *112 '403': *29 x-github: triggersNotification: true @@ -64352,8 +64370,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *454 - required: *455 + properties: *452 + required: *453 nullable: true required: - permission @@ -64419,7 +64437,7 @@ paths: application/json: schema: type: array - items: &456 + items: &454 title: Commit Comment description: Commit Comment type: object @@ -64477,7 +64495,7 @@ paths: - created_at - updated_at examples: - default: &459 + default: &457 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64544,9 +64562,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: - default: &460 + default: &458 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64627,7 +64645,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -64926,9 +64944,9 @@ paths: application/json: schema: type: array - items: *457 + items: *455 examples: - default: &573 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65024,7 +65042,7 @@ paths: parameters: - *324 - *325 - - &458 + - &456 name: commit_sha description: The SHA of the commit. in: path @@ -65098,7 +65116,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 - *17 - *19 responses: @@ -65108,9 +65126,9 @@ paths: application/json: schema: type: array - items: *456 + items: *454 examples: - default: *459 + default: *457 headers: Link: *54 x-github: @@ -65140,7 +65158,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 requestBody: required: true content: @@ -65175,9 +65193,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: - default: *460 + default: *458 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65207,7 +65225,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 - *17 - *19 responses: @@ -65217,9 +65235,9 @@ paths: application/json: schema: type: array - items: *461 + items: *459 examples: - default: &565 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -65760,7 +65778,7 @@ paths: - *325 - *19 - *17 - - &462 + - &460 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)" @@ -65775,9 +65793,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *455 examples: - default: &550 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65892,9 +65910,9 @@ paths: parameters: - *324 - *325 + - *460 + - *461 - *462 - - *463 - - *464 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -65928,9 +65946,9 @@ paths: type: integer check_runs: type: array - items: *406 + items: *404 examples: - default: *465 + default: *463 headers: Link: *54 x-github: @@ -65957,7 +65975,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -65965,7 +65983,7 @@ paths: schema: type: integer example: 1 - - *463 + - *461 - *17 - *19 responses: @@ -65983,7 +66001,7 @@ paths: type: integer check_suites: type: array - items: *411 + items: *409 examples: default: value: @@ -66185,7 +66203,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - *17 - *19 responses: @@ -66252,7 +66270,7 @@ paths: type: string total_count: type: integer - repository: *142 + repository: *143 commit_url: type: string format: uri @@ -66385,7 +66403,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - *17 - *19 responses: @@ -66395,7 +66413,7 @@ paths: application/json: schema: type: array - items: &638 + items: &637 title: Status description: The status of a commit. type: object @@ -66476,7 +66494,7 @@ paths: site_admin: false headers: Link: *54 - '301': *333 + '301': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66534,20 +66552,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *466 - required: *467 + properties: *464 + required: *465 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &468 + properties: &466 url: type: string format: uri html_url: type: string format: uri - required: &469 + required: &467 - url - html_url nullable: true @@ -66561,26 +66579,26 @@ paths: contributing: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true readme: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true issue_template: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true pull_request_template: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true required: - code_of_conduct @@ -66751,8 +66769,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *457 - merge_base_commit: *457 + base_commit: *455 + merge_base_commit: *455 status: type: string enum: @@ -66772,10 +66790,10 @@ paths: example: 6 commits: type: array - items: *457 + items: *455 files: type: array - items: *470 + items: *468 required: - url - html_url @@ -67205,7 +67223,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &471 + response-if-content-is-a-file: &469 summary: Response if content is a file value: type: file @@ -67337,7 +67355,7 @@ paths: - size - type - url - - &578 + - &577 title: Content File description: Content File type: object @@ -67538,7 +67556,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *471 + response-if-content-is-a-file: *469 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67607,7 +67625,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *472 + '302': *470 '304': *37 x-github: githubCloudOnly: false @@ -67724,7 +67742,7 @@ paths: description: Response content: application/json: - schema: &473 + schema: &471 title: File Commit description: File Commit type: object @@ -67876,7 +67894,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: example-for-creating-a-file: value: @@ -67930,7 +67948,7 @@ paths: schema: oneOf: - *3 - - &503 + - &501 description: Repository rule violation was detected type: object properties: @@ -67951,7 +67969,7 @@ paths: items: type: object properties: - placeholder_id: &630 + placeholder_id: &629 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68045,7 +68063,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: default: value: @@ -68226,20 +68244,20 @@ paths: parameters: - *324 - *325 - - *179 - *180 - *181 - *182 + - *183 - 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 - - *183 - - *474 - *184 + - *472 - *185 + - *186 - *48 - name: per_page description: The number of results per page (max 100). For more information, @@ -68258,11 +68276,11 @@ paths: application/json: schema: type: array - items: &477 + items: &475 type: object description: A Dependabot alert. properties: - number: *158 + number: *159 state: type: string description: The state of the Dependabot alert. @@ -68304,13 +68322,13 @@ paths: - unknown - direct - transitive - security_advisory: *475 + security_advisory: *473 security_vulnerability: *52 - url: *161 - html_url: *162 - created_at: *159 - updated_at: *160 - dismissed_at: *164 + url: *162 + html_url: *163 + created_at: *160 + updated_at: *161 + dismissed_at: *165 dismissed_by: title: Simple User description: A GitHub user. @@ -68334,8 +68352,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *163 - auto_dismissed_at: *476 + fixed_at: *164 + auto_dismissed_at: *474 required: - number - state @@ -68567,7 +68585,7 @@ paths: parameters: - *324 - *325 - - &478 + - &476 name: alert_number in: path description: |- @@ -68576,13 +68594,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *158 + schema: *159 responses: '200': description: Response content: application/json: - schema: *477 + schema: *475 examples: default: value: @@ -68697,7 +68715,7 @@ paths: parameters: - *324 - *325 - - *478 + - *476 requestBody: required: true content: @@ -68742,7 +68760,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *475 examples: default: value: @@ -68890,7 +68908,7 @@ paths: type: integer secrets: type: array - items: &481 + items: &479 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -68950,9 +68968,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *477 examples: - default: *480 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68974,13 +68992,13 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *481 + schema: *479 examples: default: value: @@ -69008,7 +69026,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -69036,7 +69054,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -69062,7 +69080,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -69561,7 +69579,7 @@ paths: - version - url additionalProperties: false - metadata: &482 + metadata: &480 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69594,7 +69612,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *482 + metadata: *480 resolved: type: object description: A collection of resolved package dependencies. @@ -69607,7 +69625,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *482 + metadata: *480 relationship: type: string description: A notation of whether a dependency is requested @@ -69777,9 +69795,9 @@ paths: application/json: schema: type: array - items: *483 + items: *481 examples: - default: *484 + default: *482 headers: Link: *54 x-github: @@ -69927,7 +69945,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: simple-example: summary: Simple example @@ -70002,7 +70020,7 @@ paths: parameters: - *324 - *325 - - &485 + - &483 name: deployment_id description: deployment_id parameter in: path @@ -70014,7 +70032,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: default: value: @@ -70081,7 +70099,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 responses: '204': description: Response @@ -70105,7 +70123,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 - *17 - *19 responses: @@ -70115,7 +70133,7 @@ paths: application/json: schema: type: array - items: &486 + items: &484 title: Deployment Status description: The status of a deployment. type: object @@ -70278,7 +70296,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 requestBody: required: true content: @@ -70353,9 +70371,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: &487 + default: &485 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70413,7 +70431,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 - name: status_id in: path required: true @@ -70424,9 +70442,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: *487 + default: *485 '404': *6 x-github: githubCloudOnly: false @@ -70527,7 +70545,7 @@ paths: type: integer environments: type: array - items: &489 + items: &487 title: Environment description: Details of a deployment environment type: object @@ -70579,7 +70597,7 @@ paths: type: type: string example: wait_timer - wait_timer: &491 + wait_timer: &489 type: integer example: 30 description: The amount of time to delay a job after @@ -70616,11 +70634,11 @@ paths: items: type: object properties: - type: *488 + type: *486 reviewer: anyOf: - *4 - - *178 + - *179 required: - id - node_id @@ -70640,7 +70658,7 @@ paths: - id - node_id - type - deployment_branch_policy: &492 + deployment_branch_policy: &490 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -70758,7 +70776,7 @@ paths: parameters: - *324 - *325 - - &490 + - &488 name: environment_name in: path required: true @@ -70771,9 +70789,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: &493 + default: &491 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -70859,7 +70877,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: false content: @@ -70868,7 +70886,7 @@ paths: type: object nullable: true properties: - wait_timer: *491 + wait_timer: *489 prevent_self_review: type: boolean example: false @@ -70885,13 +70903,13 @@ paths: items: type: object properties: - type: *488 + type: *486 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *492 + deployment_branch_policy: *490 additionalProperties: false examples: default: @@ -70911,9 +70929,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: *493 + default: *491 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -70939,7 +70957,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 responses: '204': description: Default response @@ -70966,7 +70984,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 - *17 - *19 responses: @@ -70984,7 +71002,7 @@ paths: example: 2 branch_policies: type: array - items: &494 + items: &492 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71043,7 +71061,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: true content: @@ -71089,9 +71107,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - example-wildcard: &495 + example-wildcard: &493 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71135,8 +71153,8 @@ paths: parameters: - *324 - *325 - - *490 - - &496 + - *488 + - &494 name: branch_policy_id in: path required: true @@ -71148,9 +71166,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - default: *495 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71171,8 +71189,8 @@ paths: parameters: - *324 - *325 - - *490 - - *496 + - *488 + - *494 requestBody: required: true content: @@ -71200,9 +71218,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - default: *495 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71223,8 +71241,8 @@ paths: parameters: - *324 - *325 - - *490 - - *496 + - *488 + - *494 responses: '204': description: Response @@ -71249,7 +71267,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *490 + - *488 - *325 - *324 responses: @@ -71267,7 +71285,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &497 + items: &495 title: Deployment protection rule description: Deployment protection rule type: object @@ -71286,7 +71304,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &498 + app: &496 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71385,7 +71403,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: - - *490 + - *488 - *325 - *324 requestBody: @@ -71408,9 +71426,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *497 + schema: *495 examples: - default: &499 + default: &497 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71445,7 +71463,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: - - *490 + - *488 - *325 - *324 - *19 @@ -71466,7 +71484,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *498 + items: *496 examples: default: value: @@ -71503,8 +71521,8 @@ paths: parameters: - *324 - *325 - - *490 - - &500 + - *488 + - &498 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71516,9 +71534,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *495 examples: - default: *499 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71539,10 +71557,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *490 + - *488 - *325 - *324 - - *500 + - *498 responses: '204': description: Response @@ -71570,7 +71588,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 - *17 - *19 responses: @@ -71588,9 +71606,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *370 examples: - default: *373 + default: *371 headers: Link: *54 x-github: @@ -71617,15 +71635,15 @@ paths: parameters: - *324 - *325 - - *490 + - *488 responses: '200': description: Response content: application/json: - schema: *374 + schema: *372 examples: - default: *375 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71649,16 +71667,16 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 responses: '200': description: Response content: application/json: - schema: *372 + schema: *370 examples: - default: *501 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71682,8 +71700,8 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 requestBody: required: true content: @@ -71714,7 +71732,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -71742,8 +71760,8 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 responses: '204': description: Default response @@ -71770,8 +71788,8 @@ paths: parameters: - *324 - *325 - - *490 - - *343 + - *488 + - *341 - *19 responses: '200': @@ -71788,9 +71806,9 @@ paths: type: integer variables: type: array - items: *376 + items: *374 examples: - default: *377 + default: *375 headers: Link: *54 x-github: @@ -71815,7 +71833,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: true content: @@ -71842,7 +71860,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -71869,16 +71887,16 @@ paths: parameters: - *324 - *325 - - *490 - - *153 + - *488 + - *154 responses: '200': description: Response content: application/json: - schema: *376 + schema: *374 examples: - default: *502 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71901,8 +71919,8 @@ paths: parameters: - *324 - *325 - - *153 - - *490 + - *154 + - *488 requestBody: required: true content: @@ -71946,8 +71964,8 @@ paths: parameters: - *324 - *325 - - *153 - - *490 + - *154 + - *488 responses: '204': description: Response @@ -72061,7 +72079,7 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: default: value: @@ -72231,9 +72249,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 '400': *14 '422': *15 '403': *29 @@ -72314,8 +72332,8 @@ paths: application/json: schema: oneOf: - - *111 - - *503 + - *112 + - *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72550,7 +72568,7 @@ paths: description: Response content: application/json: - schema: &504 + schema: &502 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -72766,13 +72784,13 @@ paths: parameters: - *324 - *325 - - *458 + - *456 responses: '200': description: Response content: application/json: - schema: *504 + schema: *502 examples: default: value: @@ -72830,7 +72848,7 @@ paths: parameters: - *324 - *325 - - &505 + - &503 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. @@ -72847,7 +72865,7 @@ paths: application/json: schema: type: array - items: &506 + items: &504 title: Git Reference description: Git references within a repository type: object @@ -72924,15 +72942,15 @@ paths: parameters: - *324 - *325 - - *505 + - *503 responses: '200': description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: &507 + default: &505 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -72991,9 +73009,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: *507 + default: *505 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73021,7 +73039,7 @@ paths: parameters: - *324 - *325 - - *505 + - *503 requestBody: required: true content: @@ -73050,9 +73068,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: *507 + default: *505 '422': *15 '409': *47 x-github: @@ -73072,7 +73090,7 @@ paths: parameters: - *324 - *325 - - *505 + - *503 responses: '204': description: Response @@ -73195,7 +73213,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &507 title: Git Tag description: Metadata for a Git tag type: object @@ -73246,7 +73264,7 @@ paths: - sha - type - url - verification: *508 + verification: *506 required: - sha - url @@ -73256,7 +73274,7 @@ paths: - tag - message examples: - default: &510 + default: &508 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73341,9 +73359,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *507 examples: - default: *510 + default: *508 '404': *6 '409': *47 x-github: @@ -73441,7 +73459,7 @@ paths: description: Response content: application/json: - schema: &511 + schema: &509 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73561,7 +73579,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *509 examples: default-response: summary: Default response @@ -73631,7 +73649,7 @@ paths: application/json: schema: type: array - items: &512 + items: &510 title: Webhook description: Webhooks for repositories. type: object @@ -73685,7 +73703,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &753 + last_response: &752 title: Hook Response type: object properties: @@ -73812,9 +73830,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: &513 + default: &511 value: type: Repository id: 12345678 @@ -73864,15 +73882,15 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '200': description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -73894,7 +73912,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 requestBody: required: true content: @@ -73939,9 +73957,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '422': *15 '404': *6 x-github: @@ -73964,7 +73982,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -73990,7 +74008,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '200': description: Response @@ -74019,7 +74037,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 requestBody: required: false content: @@ -74065,9 +74083,9 @@ paths: parameters: - *324 - *325 - - *193 - - *17 - *194 + - *17 + - *195 responses: '200': description: Response @@ -74075,9 +74093,9 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '400': *14 '422': *15 x-github: @@ -74098,16 +74116,16 @@ paths: parameters: - *324 - *325 - - *193 + - *194 - *16 responses: '200': description: Response content: application/json: - schema: *197 + schema: *198 examples: - default: *198 + default: *199 '400': *14 '422': *15 x-github: @@ -74128,7 +74146,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 - *16 responses: '202': *39 @@ -74153,7 +74171,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -74180,7 +74198,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -74253,7 +74271,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '409': *47 x-github: githubCloudOnly: false @@ -74274,7 +74292,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '409': *47 x-github: githubCloudOnly: false @@ -74336,7 +74354,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &512 title: Import description: A repository import from an external source. type: object @@ -74435,7 +74453,7 @@ paths: - html_url - authors_url examples: - default: &517 + default: &515 value: vcs: subversion use_lfs: true @@ -74451,7 +74469,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': &515 + '503': &513 description: Unavailable due to service under maintenance. content: application/json: @@ -74529,7 +74547,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: default: value: @@ -74554,7 +74572,7 @@ paths: type: string '422': *15 '404': *6 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74632,7 +74650,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: example-1: summary: Example 1 @@ -74680,7 +74698,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': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74708,7 +74726,7 @@ paths: responses: '204': description: Response - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74736,7 +74754,7 @@ paths: parameters: - *324 - *325 - - &689 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -74750,7 +74768,7 @@ paths: application/json: schema: type: array - items: &516 + items: &514 title: Porter Author description: Porter Author type: object @@ -74804,7 +74822,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': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74860,7 +74878,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: default: value: @@ -74873,7 +74891,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74939,7 +74957,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74995,11 +75013,11 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: - default: *517 + default: *515 '422': *15 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75031,8 +75049,8 @@ paths: application/json: schema: *22 examples: - default: *518 - '301': *333 + default: *516 + '301': *331 '404': *6 x-github: githubCloudOnly: false @@ -75061,12 +75079,12 @@ paths: application/json: schema: anyOf: - - *211 + - *212 - type: object properties: {} additionalProperties: false examples: - default: &520 + default: &518 value: limit: collaborators_only origin: repository @@ -75097,7 +75115,7 @@ paths: required: true content: application/json: - schema: *519 + schema: *517 examples: default: summary: Example request body @@ -75109,9 +75127,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *520 + default: *518 '409': description: Response x-github: @@ -75168,9 +75186,9 @@ paths: application/json: schema: type: array - items: *521 + items: *519 examples: - default: &682 + default: &681 value: - id: 1 repository: @@ -75303,7 +75321,7 @@ paths: parameters: - *324 - *325 - - *215 + - *216 requestBody: required: false content: @@ -75332,7 +75350,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *519 examples: default: value: @@ -75465,7 +75483,7 @@ paths: parameters: - *324 - *325 - - *215 + - *216 responses: '204': description: Response @@ -75545,7 +75563,7 @@ paths: required: false schema: type: string - - *219 + - *220 - name: sort description: What to sort results by. in: query @@ -75570,7 +75588,7 @@ paths: type: array items: *82 examples: - default: &530 + default: &529 value: - id: 1 node_id: MDU6SXNzdWUx @@ -75718,7 +75736,7 @@ paths: state_reason: completed headers: Link: *54 - '301': *333 + '301': *331 '422': *15 '404': *6 x-github: @@ -75832,7 +75850,7 @@ paths: application/json: schema: *82 examples: - default: &527 + default: &526 value: id: 1 node_id: MDU6SXNzdWUx @@ -75988,7 +76006,7 @@ paths: '422': *15 '503': *104 '404': *6 - '410': *330 + '410': *520 x-github: triggersNotification: true githubCloudOnly: false @@ -76038,9 +76056,9 @@ paths: application/json: schema: type: array - items: *522 + items: *521 examples: - default: &529 + default: &528 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76106,9 +76124,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: &523 + default: &522 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76186,9 +76204,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: *523 + default: *522 '422': *15 x-github: githubCloudOnly: false @@ -76378,7 +76396,7 @@ paths: application/json: schema: type: array - items: &526 + items: &525 title: Issue Event description: Issue Event type: object @@ -76421,8 +76439,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *524 - required: *525 + properties: *523 + required: *524 nullable: true label: title: Issue Event Label @@ -76466,7 +76484,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *178 + requested_team: *179 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76741,7 +76759,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: default: value: @@ -76934,7 +76952,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *330 + '410': *520 '403': *29 x-github: githubCloudOnly: false @@ -76970,7 +76988,7 @@ paths: parameters: - *324 - *325 - - &528 + - &527 name: issue_number description: The number that identifies the issue. in: path @@ -76984,10 +77002,10 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '404': *6 - '410': *330 + '410': *520 '304': *37 x-github: githubCloudOnly: false @@ -77014,7 +77032,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -77120,13 +77138,13 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 '422': *15 '503': *104 '403': *29 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77146,7 +77164,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -77174,7 +77192,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77192,7 +77210,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: content: application/json: @@ -77219,7 +77237,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77243,7 +77261,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: assignee in: path required: true @@ -77285,7 +77303,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *72 - *17 - *19 @@ -77296,13 +77314,13 @@ paths: application/json: schema: type: array - items: *522 + items: *521 examples: - default: *529 + default: *528 headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77333,7 +77351,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -77355,16 +77373,16 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: *523 + default: *522 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -77394,7 +77412,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77406,12 +77424,12 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77441,7 +77459,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -77465,15 +77483,15 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *333 + '301': *331 '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -77506,7 +77524,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77520,13 +77538,13 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *330 + '410': *520 x-github: triggersNotification: true githubCloudOnly: false @@ -77554,7 +77572,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77566,12 +77584,12 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77590,7 +77608,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77604,7 +77622,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &533 + - &532 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77658,7 +77676,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &534 + - &533 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -77794,7 +77812,7 @@ paths: - performed_via_github_app - assignee - assigner - - &535 + - &534 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -77845,7 +77863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &535 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -77896,7 +77914,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &536 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -77950,7 +77968,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &537 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -77984,7 +78002,7 @@ paths: properties: *67 required: *68 review_requester: *4 - requested_team: *178 + requested_team: *179 requested_reviewer: *4 required: - review_requester @@ -77997,7 +78015,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &538 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78031,7 +78049,7 @@ paths: properties: *67 required: *68 review_requester: *4 - requested_team: *178 + requested_team: *179 requested_reviewer: *4 required: - review_requester @@ -78044,7 +78062,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &539 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78104,7 +78122,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &540 title: Locked Issue Event description: Locked Issue Event type: object @@ -78152,7 +78170,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &541 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78218,7 +78236,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &542 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78284,7 +78302,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &543 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78350,7 +78368,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &544 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78441,7 +78459,7 @@ paths: color: red headers: Link: *54 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78460,7 +78478,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -78470,7 +78488,7 @@ paths: application/json: schema: type: array - items: &531 + items: &530 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78517,7 +78535,7 @@ paths: - color - default examples: - default: &532 + default: &531 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78535,9 +78553,9 @@ paths: default: false headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78556,7 +78574,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78615,12 +78633,12 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 - '301': *333 + default: *531 + '301': *331 '404': *6 - '410': *330 + '410': *520 '422': *15 x-github: githubCloudOnly: false @@ -78639,7 +78657,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78699,12 +78717,12 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 - '301': *333 + default: *531 + '301': *331 '404': *6 - '410': *330 + '410': *520 '422': *15 x-github: githubCloudOnly: false @@ -78723,13 +78741,13 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '204': description: Response - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78750,7 +78768,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: name in: path required: true @@ -78763,7 +78781,7 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: default: value: @@ -78774,9 +78792,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78798,7 +78816,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78826,7 +78844,7 @@ paths: '204': description: Response '403': *29 - '410': *330 + '410': *520 '404': *6 '422': *15 x-github: @@ -78846,7 +78864,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '204': description: Response @@ -78878,7 +78896,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '200': description: Response @@ -78886,10 +78904,10 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78908,7 +78926,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - 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. @@ -78940,7 +78958,7 @@ paths: headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78960,7 +78978,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79025,7 +79043,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *320 responses: '204': @@ -79057,7 +79075,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79081,7 +79099,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79116,7 +79134,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -79128,11 +79146,11 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79162,7 +79180,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79191,14 +79209,14 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -79220,7 +79238,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79253,7 +79271,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 '403': *29 '404': *6 '422': *7 @@ -79277,7 +79295,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -79292,6 +79310,7 @@ paths: description: Timeline Event type: object anyOf: + - *532 - *533 - *534 - *535 @@ -79304,7 +79323,6 @@ paths: - *542 - *543 - *544 - - *545 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79613,7 +79631,7 @@ paths: type: string comments: type: array - items: &567 + items: &566 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -79822,7 +79840,7 @@ paths: type: string comments: type: array - items: *456 + items: *454 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80111,7 +80129,7 @@ paths: headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80139,7 +80157,7 @@ paths: application/json: schema: type: array - items: &546 + items: &545 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80242,9 +80260,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *545 examples: - default: &547 + default: &546 value: id: 1 key: ssh-rsa AAA... @@ -80280,7 +80298,7 @@ paths: parameters: - *324 - *325 - - &548 + - &547 name: key_id description: The unique identifier of the key. in: path @@ -80292,9 +80310,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *545 examples: - default: *547 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80314,7 +80332,7 @@ paths: parameters: - *324 - *325 - - *548 + - *547 responses: '204': description: Response @@ -80345,9 +80363,9 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 + default: *531 headers: Link: *54 '404': *6 @@ -80405,9 +80423,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: - default: &549 + default: &548 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80451,9 +80469,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: - default: *549 + default: *548 '404': *6 x-github: githubCloudOnly: false @@ -80510,7 +80528,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: default: value: @@ -80605,7 +80623,7 @@ paths: parameters: - *324 - *325 - - *432 + - *430 responses: '200': description: Response @@ -80851,9 +80869,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *457 + schema: *455 examples: - default: *550 + default: *549 '204': description: Response when already merged '404': @@ -80920,7 +80938,7 @@ paths: application/json: schema: type: array - items: &551 + items: &550 title: Milestone description: A collection of related issues and pull requests. type: object @@ -81022,9 +81040,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: &552 + default: &551 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81085,7 +81103,7 @@ paths: parameters: - *324 - *325 - - &553 + - &552 name: milestone_number description: The number that identifies the milestone. in: path @@ -81097,9 +81115,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: *552 + default: *551 '404': *6 x-github: githubCloudOnly: false @@ -81118,7 +81136,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 requestBody: required: false content: @@ -81156,9 +81174,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: *552 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81176,7 +81194,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 responses: '204': description: Response @@ -81199,7 +81217,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 - *17 - *19 responses: @@ -81209,9 +81227,9 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 + default: *531 headers: Link: *54 x-github: @@ -81232,10 +81250,10 @@ paths: parameters: - *324 - *325 + - *553 - *554 - - *555 - *72 - - *556 + - *555 - *17 - *19 responses: @@ -81247,7 +81265,7 @@ paths: type: array items: *95 examples: - default: *557 + default: *556 headers: Link: *54 x-github: @@ -81337,7 +81355,7 @@ paths: description: Response content: application/json: - schema: &558 + schema: &557 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81462,7 +81480,7 @@ paths: - custom_404 - public examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81558,9 +81576,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: *559 + default: *558 '422': *15 '409': *47 x-github: @@ -81721,7 +81739,7 @@ paths: application/json: schema: type: array - items: &560 + items: &559 title: Page Build description: Page Build type: object @@ -81868,9 +81886,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: &561 + default: &560 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -81930,9 +81948,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: *561 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82060,7 +82078,7 @@ paths: parameters: - *324 - *325 - - &562 + - &561 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82120,9 +82138,9 @@ paths: parameters: - *324 - *325 - - *562 + - *561 responses: - '204': *172 + '204': *173 '404': *6 x-github: githubCloudOnly: false @@ -82379,7 +82397,7 @@ paths: description: Empty response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -82447,7 +82465,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '422': *14 x-github: githubCloudOnly: false @@ -82469,155 +82487,13 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '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: - - *324 - - *325 - - 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: *250 - 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: *54 - '401': *25 - '403': *29 - '404': *6 - '410': *330 - '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: - - *324 - - *325 - 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: *250 - examples: - default: *329 - '401': *25 - '403': *29 - '404': *6 - '410': *330 - '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 @@ -82642,7 +82518,7 @@ paths: type: array items: *102 examples: - default: *563 + default: *562 '403': *29 '404': *6 x-github: @@ -82681,7 +82557,7 @@ paths: required: - properties examples: - default: *564 + default: *563 responses: '204': description: No Content when custom property values are successfully created @@ -82780,9 +82656,9 @@ paths: application/json: schema: type: array - items: *461 + items: *459 examples: - default: *565 + default: *564 headers: Link: *54 '304': *37 @@ -82880,7 +82756,7 @@ paths: description: Response content: application/json: - schema: &569 + schema: &568 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83094,7 +82970,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: *566 + auto_merge: *565 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83186,7 +83062,7 @@ paths: - merged_by - review_comments examples: - default: &570 + default: &569 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83743,9 +83619,9 @@ paths: application/json: schema: type: array - items: *567 + items: *566 examples: - default: &572 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83830,9 +83706,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: - default: &568 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83931,9 +83807,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: - default: *568 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84136,7 +84012,7 @@ paths: parameters: - *324 - *325 - - &571 + - &570 name: pull_number description: The number that identifies the pull request. in: path @@ -84149,9 +84025,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *569 + schema: *568 examples: - default: *570 + default: *569 '304': *37 '404': *6 '406': @@ -84188,7 +84064,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -84230,9 +84106,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *568 examples: - default: *570 + default: *569 '422': *15 '403': *29 x-github: @@ -84256,7 +84132,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -84316,17 +84192,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -84358,7 +84234,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *92 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -84379,9 +84255,9 @@ paths: application/json: schema: type: array - items: *567 + items: *566 examples: - default: *572 + default: *571 headers: Link: *54 x-github: @@ -84416,7 +84292,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -84521,7 +84397,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: example-for-a-multi-line-comment: value: @@ -84611,7 +84487,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *81 requestBody: required: true @@ -84634,7 +84510,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: default: value: @@ -84722,7 +84598,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -84732,9 +84608,9 @@ paths: application/json: schema: type: array - items: *457 + items: *455 examples: - default: *573 + default: *572 headers: Link: *54 x-github: @@ -84766,7 +84642,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -84776,7 +84652,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: value: @@ -84816,7 +84692,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 responses: '204': description: Response if pull request has been merged @@ -84841,7 +84717,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -84954,7 +84830,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 responses: '200': description: Response @@ -84970,7 +84846,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 required: - users - teams @@ -85031,7 +84907,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -85068,7 +84944,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -85606,7 +85482,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -85640,7 +85516,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -86147,7 +86023,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -86157,7 +86033,7 @@ paths: application/json: schema: type: array - items: &574 + items: &573 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86310,7 +86186,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -86396,9 +86272,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &576 + default: &575 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86463,8 +86339,8 @@ paths: parameters: - *324 - *325 - - *571 - - &575 + - *570 + - &574 name: review_id description: The unique identifier of the review. in: path @@ -86476,9 +86352,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &577 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86539,8 +86415,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -86563,7 +86439,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: default: value: @@ -86627,16 +86503,16 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 responses: '200': description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *576 + default: *575 '422': *7 '404': *6 x-github: @@ -86665,8 +86541,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 - *17 - *19 responses: @@ -86903,8 +86779,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -86932,7 +86808,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: default: value: @@ -86997,8 +86873,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -87033,9 +86909,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *577 + default: *576 '404': *6 '422': *7 '403': *29 @@ -87059,7 +86935,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -87136,9 +87012,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: &579 + default: &578 value: type: file encoding: base64 @@ -87201,9 +87077,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: *579 + default: *578 '404': *6 '422': *15 x-github: @@ -87236,7 +87112,7 @@ paths: application/json: schema: type: array - items: &580 + items: &579 title: Release description: A release. type: object @@ -87307,7 +87183,7 @@ paths: author: *4 assets: type: array - items: &581 + items: &580 title: Release Asset description: Data related to a release. type: object @@ -87571,9 +87447,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: &584 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87680,7 +87556,7 @@ paths: parameters: - *324 - *325 - - &582 + - &581 name: asset_id description: The unique identifier of the asset. in: path @@ -87692,9 +87568,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *580 examples: - default: &583 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87729,7 +87605,7 @@ paths: type: User site_admin: false '404': *6 - '302': *472 + '302': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87747,7 +87623,7 @@ paths: parameters: - *324 - *325 - - *582 + - *581 requestBody: required: false content: @@ -87775,9 +87651,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *580 examples: - default: *583 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87795,7 +87671,7 @@ paths: parameters: - *324 - *325 - - *582 + - *581 responses: '204': description: Response @@ -87912,9 +87788,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87945,9 +87821,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -87971,7 +87847,7 @@ paths: parameters: - *324 - *325 - - &585 + - &584 name: release_id description: The unique identifier of the release. in: path @@ -87985,9 +87861,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: *580 + schema: *579 examples: - default: *584 + default: *583 '401': description: Unauthorized x-github: @@ -88007,7 +87883,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 requestBody: required: false content: @@ -88071,9 +87947,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 '404': description: Not Found if the discussion category name is invalid content: @@ -88096,7 +87972,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 responses: '204': description: Response @@ -88118,7 +87994,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - *17 - *19 responses: @@ -88128,7 +88004,7 @@ paths: application/json: schema: type: array - items: *581 + items: *580 examples: default: value: @@ -88211,7 +88087,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - name: name in: query required: true @@ -88237,7 +88113,7 @@ paths: description: Response for successful upload content: application/json: - schema: *581 + schema: *580 examples: response-for-successful-upload: value: @@ -88294,7 +88170,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88343,7 +88219,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 requestBody: required: true content: @@ -88406,7 +88282,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - *320 responses: '204': @@ -88433,7 +88309,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 - *17 - *19 responses: @@ -88450,7 +88326,7 @@ paths: oneOf: - allOf: - *275 - - &586 + - &585 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88471,67 +88347,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *276 - - *586 + - *585 - allOf: - *277 - - *586 + - *585 - allOf: - *278 - - *586 + - *585 - allOf: - - *587 - *586 + - *585 - allOf: - *279 - - *586 + - *585 - allOf: - *280 - - *586 + - *585 - allOf: - *281 - - *586 + - *585 - allOf: - *282 - - *586 + - *585 - allOf: - *283 - - *586 + - *585 - allOf: - *284 - - *586 + - *585 - allOf: - *285 - - *586 + - *585 - allOf: - *286 - - *586 + - *585 - allOf: - *287 - - *586 + - *585 - allOf: - *288 - - *586 + - *585 - allOf: - *289 - - *586 + - *585 - allOf: - *290 - - *586 + - *585 - allOf: - *291 - - *586 + - *585 - allOf: - *292 - - *586 + - *585 - allOf: - *293 - - *586 + - *585 - allOf: - *294 - - *586 + - *585 - allOf: - - *588 - - *586 + - *587 + - *585 examples: default: value: @@ -88582,7 +88458,7 @@ paths: schema: type: boolean default: true - - *589 + - *588 responses: '200': description: Response @@ -88667,7 +88543,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *590 + items: *589 required: - name - enforcement @@ -88700,7 +88576,7 @@ paths: application/json: schema: *295 examples: - default: &600 + default: &599 value: id: 42 name: super cool ruleset @@ -88749,10 +88625,10 @@ paths: parameters: - *324 - *325 + - *590 - *591 - *592 - *593 - - *594 - *17 - *19 responses: @@ -88760,9 +88636,9 @@ paths: description: Response content: application/json: - schema: *595 + schema: *594 examples: - default: *596 + default: *595 '404': *6 '500': *103 x-github: @@ -88785,15 +88661,15 @@ paths: parameters: - *324 - *325 - - *597 + - *596 responses: '200': description: Response content: application/json: - schema: *598 + schema: *597 examples: - default: *599 + default: *598 '404': *6 '500': *103 x-github: @@ -88844,7 +88720,7 @@ paths: application/json: schema: *295 examples: - default: *600 + default: *599 '404': *6 '500': *103 put: @@ -88897,7 +88773,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *590 + items: *589 examples: default: value: @@ -88927,7 +88803,7 @@ paths: application/json: schema: *295 examples: - default: *600 + default: *599 '404': *6 '500': *103 delete: @@ -88988,7 +88864,7 @@ paths: type: array items: *298 examples: - default: *601 + default: *600 '404': *6 '500': *103 x-github: @@ -89026,7 +88902,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *601 examples: default: value: @@ -89083,19 +88959,19 @@ paths: parameters: - *324 - *325 + - *602 - *603 - *604 - *605 - - *606 - *48 - *19 - *17 + - *606 - *607 - *608 - *609 - *610 - *611 - - *612 responses: '200': description: Response @@ -89103,11 +88979,11 @@ paths: application/json: schema: type: array - items: &616 + items: &615 type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89115,15 +88991,15 @@ paths: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *613 - resolution: *614 + state: *612 + resolution: *613 resolved_at: type: string format: date-time @@ -89219,7 +89095,7 @@ paths: pull request. ' - oneOf: *615 + oneOf: *614 nullable: true has_more_locations: type: boolean @@ -89370,14 +89246,14 @@ paths: parameters: - *324 - *325 - - *426 - - *612 + - *424 + - *611 responses: '200': description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -89431,7 +89307,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: true content: @@ -89439,15 +89315,16 @@ paths: schema: type: object properties: - state: *613 - resolution: *614 + state: *612 + resolution: *613 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -89458,7 +89335,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -89535,7 +89412,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 - *19 - *17 responses: @@ -89546,7 +89423,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &775 + items: &774 type: object properties: type: @@ -89572,6 +89449,7 @@ paths: example: commit details: oneOf: + - *616 - *617 - *618 - *619 @@ -89584,7 +89462,6 @@ paths: - *626 - *627 - *628 - - *629 examples: default: value: @@ -89679,14 +89556,14 @@ paths: schema: type: object properties: - reason: &631 + reason: &630 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *630 + placeholder_id: *629 required: - reason - placeholder_id @@ -89703,7 +89580,7 @@ paths: schema: type: object properties: - reason: *631 + reason: *630 expire_at: type: string format: date-time @@ -89765,7 +89642,7 @@ paths: properties: incremental_scans: type: array - items: &632 + items: &631 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89791,15 +89668,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *632 + items: *631 backfill_scans: type: array - items: *632 + items: *631 custom_pattern_backfill_scans: type: array items: allOf: - - *632 + - *631 - type: object properties: pattern_name: @@ -89914,9 +89791,9 @@ paths: application/json: schema: type: array - items: *633 + items: *632 examples: - default: *634 + default: *633 '400': *14 '404': *6 x-github: @@ -90100,9 +89977,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: &636 + default: &635 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90440,7 +90317,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: default: value: @@ -90589,15 +90466,15 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '200': description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: *636 + default: *635 '403': *29 '404': *6 x-github: @@ -90623,7 +90500,7 @@ paths: parameters: - *324 - *325 - - *635 + - *634 requestBody: required: true content: @@ -90782,17 +90659,17 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: *636 - add_credit: *636 + default: *635 + add_credit: *635 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *111 + schema: *112 examples: invalid_state_transition: value: @@ -90825,7 +90702,7 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '202': *39 '400': *14 @@ -90854,15 +90731,15 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '202': description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 '400': *14 '422': *15 '403': *29 @@ -90998,7 +90875,7 @@ paths: application/json: schema: type: array - items: &637 + items: &636 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91011,7 +90888,7 @@ paths: - 1124 - -435 '202': *39 - '204': *172 + '204': *173 '422': description: Repository contains more than 10,000 commits x-github: @@ -91081,7 +90958,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91183,7 +91060,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91371,7 +91248,7 @@ paths: application/json: schema: type: array - items: *637 + items: *636 examples: default: value: @@ -91384,7 +91261,7 @@ paths: - - 0 - 2 - 21 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91459,7 +91336,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *637 examples: default: value: @@ -91553,7 +91430,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &639 + schema: &638 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91648,7 +91525,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -91785,7 +91662,7 @@ paths: application/json: schema: type: array - items: &640 + items: &639 title: Tag protection description: Tag protection type: object @@ -91861,7 +91738,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *639 examples: default: value: @@ -91978,9 +91855,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 headers: Link: *54 '404': *6 @@ -92009,7 +91886,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &640 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92021,7 +91898,7 @@ paths: required: - names examples: - default: &642 + default: &641 value: names: - octocat @@ -92076,9 +91953,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *640 examples: - default: *642 + default: *641 '404': *6 '422': *7 x-github: @@ -92101,7 +91978,7 @@ paths: parameters: - *324 - *325 - - &643 + - &642 name: per description: The time frame to display results for. in: query @@ -92130,7 +92007,7 @@ paths: example: 128 clones: type: array - items: &644 + items: &643 title: Traffic type: object properties: @@ -92371,7 +92248,7 @@ paths: parameters: - *324 - *325 - - *643 + - *642 responses: '200': description: Response @@ -92390,7 +92267,7 @@ paths: example: 3782 views: type: array - items: *644 + items: *643 required: - uniques - count @@ -92504,7 +92381,7 @@ paths: description: Response content: application/json: - schema: *142 + schema: *143 examples: default: value: @@ -92909,9 +92786,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -92952,7 +92829,7 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: default: value: @@ -93141,7 +93018,7 @@ paths: html_url: type: string format: uri - repository: *142 + repository: *143 score: type: number file_size: @@ -93159,7 +93036,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &645 + text_matches: &644 title: Search Result Text Matches type: array items: @@ -93321,7 +93198,7 @@ paths: enum: - author-date - committer-date - - &646 + - &645 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93392,7 +93269,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true comment_count: type: integer @@ -93412,7 +93289,7 @@ paths: url: type: string format: uri - verification: *508 + verification: *506 required: - author - committer @@ -93431,7 +93308,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true parents: type: array @@ -93444,12 +93321,12 @@ paths: type: string sha: type: string - repository: *142 + repository: *143 score: type: number node_id: type: string - text_matches: *645 + text_matches: *644 required: - sha - node_id @@ -93641,7 +93518,7 @@ paths: - interactions - created - updated - - *646 + - *645 - *17 - *19 - name: advanced_search @@ -93738,11 +93615,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: type: string state_reason: @@ -93774,7 +93651,7 @@ paths: type: string format: date-time nullable: true - text_matches: *645 + text_matches: *644 pull_request: type: object properties: @@ -93818,7 +93695,7 @@ paths: timeline_url: type: string format: uri - type: *216 + type: *217 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -93999,7 +93876,7 @@ paths: enum: - created - updated - - *646 + - *645 - *17 - *19 responses: @@ -94043,7 +93920,7 @@ paths: nullable: true score: type: number - text_matches: *645 + text_matches: *644 required: - id - node_id @@ -94128,7 +94005,7 @@ paths: - forks - help-wanted-issues - updated - - *646 + - *645 - *17 - *19 responses: @@ -94367,7 +94244,7 @@ paths: - admin - pull - push - text_matches: *645 + text_matches: *644 temp_clone_token: type: string allow_merge_commit: @@ -94667,7 +94544,7 @@ paths: type: string format: uri nullable: true - text_matches: *645 + text_matches: *644 related: type: array nullable: true @@ -94858,7 +94735,7 @@ paths: - followers - repositories - joined - - *646 + - *645 - *17 - *19 responses: @@ -94962,7 +94839,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *645 + text_matches: *644 blog: type: string nullable: true @@ -95041,7 +94918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &650 + - &649 name: team_id description: The unique identifier of the team. in: path @@ -95082,7 +94959,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *650 + - *649 requestBody: required: true content: @@ -95182,7 +95059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *650 + - *649 responses: '204': description: Response @@ -95213,7 +95090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *650 + - *649 - *48 - *17 - *19 @@ -95226,7 +95103,7 @@ paths: type: array items: *311 examples: - default: *651 + default: *650 headers: Link: *54 x-github: @@ -95255,7 +95132,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *650 + - *649 requestBody: required: true content: @@ -95318,7 +95195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *650 + - *649 - *313 responses: '200': @@ -95352,7 +95229,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *650 + - *649 - *313 requestBody: required: false @@ -95378,7 +95255,7 @@ paths: application/json: schema: *311 examples: - default: *652 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95403,7 +95280,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *650 + - *649 - *313 responses: '204': @@ -95433,7 +95310,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *650 + - *649 - *313 - *48 - *17 @@ -95447,7 +95324,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *652 headers: Link: *54 x-github: @@ -95476,7 +95353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 requestBody: required: true @@ -95528,7 +95405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 responses: @@ -95563,7 +95440,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 requestBody: @@ -95589,7 +95466,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95614,7 +95491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 responses: @@ -95645,7 +95522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 - name: content @@ -95704,7 +95581,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 requestBody: @@ -95766,7 +95643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *650 + - *649 - *313 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -95824,7 +95701,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *650 + - *649 - *313 requestBody: required: true @@ -95883,7 +95760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -95893,9 +95770,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 x-github: @@ -95921,7 +95798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *650 + - *649 - name: role description: Filters members returned by their role in the team. in: query @@ -95972,7 +95849,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96009,7 +95886,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96049,7 +95926,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96086,7 +95963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 responses: '200': @@ -96095,7 +95972,7 @@ paths: application/json: schema: *321 examples: - response-if-user-is-a-team-maintainer: *655 + response-if-user-is-a-team-maintainer: *654 '404': *6 x-github: githubCloudOnly: false @@ -96128,7 +96005,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 requestBody: required: false @@ -96156,7 +96033,7 @@ paths: application/json: schema: *321 examples: - response-if-users-membership-with-team-is-now-pending: *656 + response-if-users-membership-with-team-is-now-pending: *655 '403': description: Forbidden if team synchronization is set up '422': @@ -96190,7 +96067,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96219,7 +96096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96231,7 +96108,7 @@ paths: type: array items: *322 examples: - default: *657 + default: *656 headers: Link: *54 '404': *6 @@ -96257,7 +96134,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *650 + - *649 - *323 responses: '200': @@ -96266,7 +96143,7 @@ paths: application/json: schema: *322 examples: - default: *658 + default: *657 '404': description: Not Found if project is not managed by this team x-github: @@ -96290,7 +96167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *650 + - *649 - *323 requestBody: required: false @@ -96358,7 +96235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *650 + - *649 - *323 responses: '204': @@ -96386,7 +96263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96396,9 +96273,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '404': *6 @@ -96428,7 +96305,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *650 + - *649 - *324 - *325 responses: @@ -96436,7 +96313,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *659 + schema: *658 examples: alternative-response-with-extra-repository-information: value: @@ -96587,7 +96464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *650 + - *649 - *324 - *325 requestBody: @@ -96639,7 +96516,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *650 + - *649 - *324 - *325 responses: @@ -96666,7 +96543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96676,9 +96553,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - response-if-child-teams-exist: *660 + response-if-child-teams-exist: *659 headers: Link: *54 '404': *6 @@ -96711,7 +96588,7 @@ paths: application/json: schema: oneOf: - - &662 + - &661 title: Private User description: Private User type: object @@ -96914,7 +96791,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *661 + - *660 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97067,7 +96944,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *661 examples: default: value: @@ -97270,9 +97147,9 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: - default: *222 + default: *223 '304': *37 '500': *103 '401': *25 @@ -97411,17 +97288,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -97465,7 +97342,7 @@ paths: type: integer secrets: type: array - items: &663 + items: &662 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97505,7 +97382,7 @@ paths: - visibility - selected_repositories_url examples: - default: *449 + default: *447 headers: Link: *54 x-github: @@ -97575,13 +97452,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *663 + schema: *662 examples: default: value: @@ -97611,7 +97488,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 requestBody: required: true content: @@ -97656,7 +97533,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -97684,7 +97561,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 responses: '204': description: Response @@ -97709,7 +97586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *150 + - *151 responses: '200': description: Response @@ -97725,9 +97602,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *664 + default: *663 '401': *25 '403': *29 '404': *6 @@ -97752,7 +97629,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *150 + - *151 requestBody: required: true content: @@ -97806,7 +97683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *150 + - *151 - name: repository_id in: path required: true @@ -97839,7 +97716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *150 + - *151 - name: repository_id in: path required: true @@ -97871,15 +97748,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '304': *37 '500': *103 '401': *25 @@ -97905,7 +97782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 requestBody: required: false content: @@ -97935,9 +97812,9 @@ paths: description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -97959,7 +97836,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '202': *39 '304': *37 @@ -97988,13 +97865,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '202': description: Response content: application/json: - schema: &665 + schema: &664 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98035,7 +97912,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &666 + default: &665 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98067,7 +97944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *223 + - *224 - name: export_id in: path required: true @@ -98080,9 +97957,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *664 examples: - default: *666 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -98103,7 +97980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *223 + - *224 responses: '200': description: Response @@ -98119,9 +97996,9 @@ paths: type: integer machines: type: array - items: *667 + items: *666 examples: - default: *668 + default: *667 '304': *37 '500': *103 '401': *25 @@ -98150,7 +98027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *223 + - *224 requestBody: required: true content: @@ -98200,13 +98077,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *332 + repository: *330 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *447 - required: *448 + properties: *445 + required: *446 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -98980,15 +98857,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '304': *37 '500': *103 '400': *14 @@ -99020,15 +98897,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '500': *103 '401': *25 '403': *29 @@ -99058,9 +98935,9 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: &679 + default: &678 value: - id: 197 name: hello_docker @@ -99161,7 +99038,7 @@ paths: application/json: schema: type: array - items: &669 + items: &668 title: Email description: Email type: object @@ -99226,9 +99103,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: &681 + default: &680 value: - email: octocat@github.com verified: true @@ -99303,7 +99180,7 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: default: value: @@ -99559,7 +99436,7 @@ paths: application/json: schema: type: array - items: &670 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -99690,7 +99567,7 @@ paths: - subkeys - revoked examples: - default: &695 + default: &694 value: - id: 3 name: Octocat's GPG Key @@ -99775,9 +99652,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *669 examples: - default: &671 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -99834,7 +99711,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &672 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -99846,9 +99723,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *669 examples: - default: *671 + default: *670 '404': *6 '304': *37 '403': *29 @@ -99871,7 +99748,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *672 + - *671 responses: '204': description: Response @@ -100062,7 +99939,7 @@ paths: type: array items: *66 examples: - default: *134 + default: *135 headers: Link: *54 '404': *6 @@ -100087,7 +99964,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *131 + - *132 responses: '204': description: Response @@ -100113,7 +99990,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *131 + - *132 responses: '204': description: Response @@ -100147,12 +100024,12 @@ paths: application/json: schema: anyOf: - - *211 + - *212 - type: object properties: {} additionalProperties: false examples: - default: *212 + default: *213 '204': description: Response when there are no restrictions x-github: @@ -100176,7 +100053,7 @@ paths: required: true content: application/json: - schema: *519 + schema: *517 examples: default: value: @@ -100187,7 +100064,7 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: default: value: @@ -100268,7 +100145,7 @@ paths: - closed - all default: open - - *219 + - *220 - name: sort description: What to sort results by. in: query @@ -100293,7 +100170,7 @@ paths: type: array items: *82 examples: - default: *220 + default: *221 headers: Link: *54 '404': *6 @@ -100326,7 +100203,7 @@ paths: application/json: schema: type: array - items: &673 + items: &672 title: Key description: Key type: object @@ -100427,9 +100304,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *672 examples: - default: &674 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100462,15 +100339,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *548 + - *547 responses: '200': description: Response content: application/json: - schema: *673 + schema: *672 examples: - default: *674 + default: *673 '404': *6 '304': *37 '403': *29 @@ -100493,7 +100370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *548 + - *547 responses: '204': description: Response @@ -100526,7 +100403,7 @@ paths: application/json: schema: type: array - items: &675 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100594,7 +100471,7 @@ paths: - account - plan examples: - default: &676 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100656,9 +100533,9 @@ paths: application/json: schema: type: array - items: *675 + items: *674 examples: - default: *676 + default: *675 headers: Link: *54 '304': *37 @@ -100698,7 +100575,7 @@ paths: application/json: schema: type: array - items: *225 + items: *226 examples: default: value: @@ -100806,7 +100683,7 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: default: value: @@ -100889,7 +100766,7 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: default: value: @@ -100957,7 +100834,7 @@ paths: application/json: schema: type: array - items: *227 + items: *228 examples: default: value: @@ -101210,7 +101087,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -101390,7 +101267,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *228 + - *229 - name: exclude in: query required: false @@ -101403,7 +101280,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -101597,7 +101474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *228 + - *229 responses: '302': description: Response @@ -101623,7 +101500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *228 + - *229 responses: '204': description: Response @@ -101652,8 +101529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *228 - - *677 + - *229 + - *676 responses: '204': description: Response @@ -101677,7 +101554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *228 + - *229 - *17 - *19 responses: @@ -101687,9 +101564,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '404': *6 @@ -101768,7 +101645,7 @@ paths: - docker - nuget - container - - *678 + - *677 - *19 - *17 responses: @@ -101778,10 +101655,10 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 - '400': *680 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101801,16 +101678,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 responses: '200': description: Response content: application/json: - schema: *234 + schema: *235 examples: - default: &696 + default: &695 value: id: 40201 name: octo-name @@ -101923,8 +101800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 responses: '204': description: Response @@ -101954,8 +101831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 - name: token description: package token schema: @@ -101987,8 +101864,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: - - *236 - *237 + - *238 - *19 - *17 - name: state @@ -102008,7 +101885,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -102057,15 +101934,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '200': description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -102101,9 +101978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '204': description: Response @@ -102133,9 +102010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '204': description: Response @@ -102147,97 +102024,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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: *250 - 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': *37 - '403': *29 - '401': *25 - '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 @@ -102263,9 +102049,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: *681 + default: *680 headers: Link: *54 '304': *37 @@ -102378,7 +102164,7 @@ paths: type: array items: *66 examples: - default: &688 + default: &687 summary: Default response value: - id: 1296269 @@ -102682,9 +102468,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102722,9 +102508,9 @@ paths: application/json: schema: type: array - items: *521 + items: *519 examples: - default: *682 + default: *681 headers: Link: *54 '304': *37 @@ -102747,7 +102533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *215 + - *216 responses: '204': description: Response @@ -102770,7 +102556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *215 + - *216 responses: '204': description: Response @@ -102803,7 +102589,7 @@ paths: application/json: schema: type: array - items: &683 + items: &682 title: Social account description: Social media account type: object @@ -102818,7 +102604,7 @@ paths: - provider - url examples: - default: &684 + default: &683 value: - provider: twitter url: https://twitter.com/github @@ -102880,9 +102666,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: *684 + default: *683 '422': *15 '304': *37 '404': *6 @@ -102969,7 +102755,7 @@ paths: application/json: schema: type: array - items: &685 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -102989,7 +102775,7 @@ paths: - title - created_at examples: - default: &711 + default: &710 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103055,9 +102841,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: &686 + default: &685 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103088,7 +102874,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: - - &687 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103100,9 +102886,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: *686 + default: *685 '404': *6 '304': *37 '403': *29 @@ -103125,7 +102911,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: - - *687 + - *686 responses: '204': description: Response @@ -103154,7 +102940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &712 + - &711 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 @@ -103179,11 +102965,11 @@ paths: type: array items: *66 examples: - default-response: *688 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &713 + items: &712 title: Starred Repository description: Starred Repository type: object @@ -103427,9 +103213,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '304': *37 @@ -103552,10 +103338,10 @@ paths: application/json: schema: oneOf: - - *662 - *661 + - *660 examples: - default-response: &690 + default-response: &689 summary: Default response value: login: octocat @@ -103590,7 +103376,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &691 + response-with-git-hub-plan-information: &690 summary: Response with GitHub plan information value: login: octocat @@ -103650,7 +103436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *689 + - *688 - *17 responses: '200': @@ -103699,11 +103485,11 @@ paths: application/json: schema: oneOf: - - *662 - *661 + - *660 examples: - default-response: *690 - response-with-git-hub-plan-information: *691 + default-response: *689 + response-with-git-hub-plan-information: *690 '404': *6 x-github: githubCloudOnly: false @@ -103753,8 +103539,8 @@ paths: required: - subject_digests examples: - default: *692 - withPredicateType: *693 + default: *691 + withPredicateType: *692 responses: '200': description: Response @@ -103807,7 +103593,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *694 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104012,12 +103798,12 @@ paths: initiator: type: string examples: - default: *388 + default: *386 '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -104051,9 +103837,9 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 + default: *678 '403': *29 '401': *25 x-github: @@ -104437,9 +104223,9 @@ paths: application/json: schema: type: array - items: *670 + items: *669 examples: - default: *695 + default: *694 headers: Link: *54 x-github: @@ -104543,7 +104329,7 @@ paths: application/json: schema: *22 examples: - default: *518 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104667,7 +104453,7 @@ paths: - docker - nuget - container - - *678 + - *677 - *59 - *19 - *17 @@ -104678,12 +104464,12 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 + default: *678 '403': *29 '401': *25 - '400': *680 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104703,17 +104489,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 responses: '200': description: Response content: application/json: - schema: *234 + schema: *235 examples: - default: *696 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104734,8 +104520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 responses: '204': @@ -104768,8 +104554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 - name: token description: package token @@ -104802,8 +104588,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: - - *236 - *237 + - *238 - *59 responses: '200': @@ -104812,7 +104598,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -104870,16 +104656,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 - *59 responses: '200': description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -104914,10 +104700,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *236 - *237 + - *238 - *59 - - *239 + - *240 responses: '204': description: Response @@ -104949,10 +104735,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *236 - *237 + - *238 - *59 - - *239 + - *240 responses: '204': description: Response @@ -104964,87 +104750,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: - - *59 - - 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: *250 - 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: *54 - '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 @@ -105143,7 +104848,7 @@ paths: type: array items: *254 examples: - default: *697 + default: *696 headers: Link: *54 '304': *37 @@ -105166,7 +104871,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *253 - - *698 + - *697 - *59 responses: '200': @@ -105175,7 +104880,7 @@ paths: application/json: schema: *254 examples: - default: *699 + default: *698 headers: Link: *54 '304': *37 @@ -105292,7 +104997,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *699 examples: issue: *259 pull_request: *259 @@ -105678,9 +105383,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -105710,9 +105415,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *700 examples: - default: *702 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105740,9 +105445,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *702 examples: - default: *704 + default: *703 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105763,11 +105468,11 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *59 - - *105 - - *107 - *106 - - *705 - *108 + - *107 + - *704 + - *109 responses: '200': description: Response when getting a billing premium request usage report @@ -105903,9 +105608,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *705 examples: - default: *707 + default: *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105926,9 +105631,9 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *59 - - *105 - - *708 - *106 + - *707 + - *107 responses: '200': description: Response when getting a billing usage report @@ -106007,7 +105712,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. @@ -106020,18 +105725,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: - *59 - - *105 - - *107 - *106 - - *709 - *108 - - *710 + - *107 + - *708 + - *109 + - *709 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -106162,9 +105867,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: *684 + default: *683 headers: Link: *54 x-github: @@ -106194,9 +105899,9 @@ paths: application/json: schema: type: array - items: *685 + items: *684 examples: - default: *711 + default: *710 headers: Link: *54 x-github: @@ -106221,7 +105926,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *712 + - *711 - *48 - *17 - *19 @@ -106233,11 +105938,11 @@ paths: schema: anyOf: - type: array - items: *713 + items: *712 - type: array items: *66 examples: - default-response: *688 + default-response: *687 headers: Link: *54 x-github: @@ -106266,9 +105971,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -106396,7 +106101,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &714 + enterprise: &713 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106454,7 +106159,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &715 + installation: &714 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106473,7 +106178,7 @@ x-webhooks: required: - id - node_id - organization: &716 + organization: &715 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106533,13 +106238,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &717 + repository: &716 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &747 + properties: &746 id: description: Unique identifier of the repository example: 42 @@ -107222,7 +106927,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &748 + required: &747 - archive_url - assignees_url - blobs_url @@ -107373,10 +107078,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -107452,11 +107157,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: &718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: &717 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) @@ -107679,11 +107384,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: *717 sender: *4 required: - action @@ -107866,11 +107571,11 @@ x-webhooks: - everyone required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: *717 sender: *4 required: - action @@ -107954,7 +107659,7 @@ x-webhooks: type: string enum: - completed - check_run: &720 + check_run: &719 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108007,8 +107712,8 @@ x-webhooks: type: string pull_requests: type: array - items: *405 - repository: *142 + items: *403 + repository: *143 status: example: completed type: string @@ -108045,7 +107750,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *719 + deployment: *718 details_url: example: https://example.com type: string @@ -108095,7 +107800,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *405 + items: *403 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108130,10 +107835,10 @@ x-webhooks: - output - app - pull_requests - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -108526,11 +108231,11 @@ x-webhooks: type: string enum: - created - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -108926,11 +108631,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 requested_action: description: The action requested by the user. type: object @@ -109335,11 +109040,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -110316,10 +110021,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -110989,10 +110694,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -111656,10 +111361,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -111825,7 +111530,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111970,20 +111675,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &721 + commit_oid: &720 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: *714 - installation: *715 - organization: *716 - ref: &722 + enterprise: *713 + installation: *714 + organization: *715 + ref: &721 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: *717 + repository: *716 sender: *4 required: - action @@ -112148,7 +111853,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112378,12 +112083,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -112478,7 +112183,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112649,12 +112354,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -112820,7 +112525,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112986,12 +112691,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -113091,7 +112796,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113259,16 +112964,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *717 + repository: *716 sender: *4 required: - action @@ -113365,7 +113070,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113505,12 +113210,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -113767,10 +113472,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -113850,18 +113555,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *716 - pusher_type: &723 + organization: *715 + pusher_type: &722 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &724 + ref: &723 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113871,7 +113576,7 @@ x-webhooks: enum: - tag - branch - repository: *717 + repository: *716 sender: *4 required: - ref @@ -113954,9 +113659,9 @@ x-webhooks: enum: - created definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114041,9 +113746,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114121,9 +113826,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114201,9 +113906,9 @@ x-webhooks: enum: - updated definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114280,10 +113985,10 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - repository: *717 - organization: *716 + enterprise: *713 + installation: *714 + repository: *716 + organization: *715 sender: *4 new_property_values: type: array @@ -114368,18 +114073,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - pusher_type: *723 - ref: *724 + enterprise: *713 + installation: *714 + organization: *715 + pusher_type: *722 + ref: *723 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *717 + repository: *716 sender: *4 required: - ref @@ -114463,11 +114168,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114551,11 +114256,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114639,11 +114344,11 @@ x-webhooks: type: string enum: - created - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114725,11 +114430,11 @@ x-webhooks: type: string enum: - dismissed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114811,11 +114516,11 @@ x-webhooks: type: string enum: - fixed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114898,11 +114603,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114984,11 +114689,11 @@ x-webhooks: type: string enum: - reopened - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -115065,9 +114770,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - key: &725 + enterprise: *713 + installation: *714 + key: &724 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115103,8 +114808,8 @@ x-webhooks: - verified - created_at - read_only - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -115181,11 +114886,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - key: *725 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + key: *724 + organization: *715 + repository: *716 sender: *4 required: - action @@ -115746,12 +115451,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: &729 + workflow: &728 title: Workflow type: object nullable: true @@ -116477,13 +116182,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *483 + deployment: *481 pull_requests: type: array - items: *569 - repository: *717 - organization: *716 - installation: *715 + items: *568 + repository: *716 + organization: *715 + installation: *714 sender: *4 responses: '200': @@ -116554,7 +116259,7 @@ x-webhooks: type: string enum: - approved - approver: &726 + approver: &725 type: object properties: avatar_url: @@ -116597,11 +116302,11 @@ x-webhooks: type: string comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: &727 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + reviewers: &726 type: array items: type: object @@ -116680,7 +116385,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &728 + workflow_job_run: &727 type: object properties: conclusion: @@ -117411,18 +117116,18 @@ x-webhooks: type: string enum: - rejected - approver: *726 + approver: *725 comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: *727 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + reviewers: *726 sender: *4 since: type: string - workflow_job_run: *728 + workflow_job_run: *727 workflow_job_runs: type: array items: @@ -118126,13 +117831,13 @@ x-webhooks: type: string enum: - requested - enterprise: *714 + enterprise: *713 environment: type: string - installation: *715 - organization: *716 - repository: *717 - requestor: &734 + installation: *714 + organization: *715 + repository: *716 + requestor: &733 title: User type: object nullable: true @@ -120031,12 +119736,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Deployment Workflow Run type: object @@ -120716,7 +120421,7 @@ x-webhooks: type: string enum: - answered - answer: &732 + answer: &731 type: object properties: author_association: @@ -120873,7 +120578,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &730 + discussion: &729 title: Discussion description: A Discussion in a repository. type: object @@ -121159,7 +120864,7 @@ x-webhooks: - id labels: type: array - items: *531 + items: *530 required: - repository_url - category @@ -121181,10 +120886,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121311,11 +121016,11 @@ x-webhooks: - from required: - category - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121398,11 +121103,11 @@ x-webhooks: type: string enum: - closed - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121484,7 +121189,7 @@ x-webhooks: type: string enum: - created - comment: &731 + comment: &730 type: object properties: author_association: @@ -121641,11 +121346,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121728,12 +121433,12 @@ x-webhooks: type: string enum: - deleted - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *730 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121828,12 +121533,12 @@ x-webhooks: - from required: - body - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *730 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121917,11 +121622,11 @@ x-webhooks: type: string enum: - created - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122003,11 +121708,11 @@ x-webhooks: type: string enum: - deleted - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122107,11 +121812,11 @@ x-webhooks: type: string required: - from - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122193,10 +121898,10 @@ x-webhooks: type: string enum: - labeled - discussion: *730 - enterprise: *714 - installation: *715 - label: &733 + discussion: *729 + enterprise: *713 + installation: *714 + label: &732 title: Label type: object properties: @@ -122228,8 +121933,8 @@ x-webhooks: - color - default - description - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122312,11 +122017,11 @@ x-webhooks: type: string enum: - locked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122398,11 +122103,11 @@ x-webhooks: type: string enum: - pinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122484,11 +122189,11 @@ x-webhooks: type: string enum: - reopened - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122573,16 +122278,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *730 - new_repository: *717 + new_discussion: *729 + new_repository: *716 required: - new_discussion - new_repository - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122665,10 +122370,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *730 - old_answer: *732 - organization: *716 - repository: *717 + discussion: *729 + old_answer: *731 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122750,12 +122455,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *730 - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122838,11 +122543,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122924,11 +122629,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -123001,7 +122706,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *714 + enterprise: *713 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123661,9 +123366,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - forkee @@ -123809,9 +123514,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pages: description: The pages that were updated. type: array @@ -123848,7 +123553,7 @@ x-webhooks: - action - sha - html_url - repository: *717 + repository: *716 sender: *4 required: - pages @@ -123924,10 +123629,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: &735 + organization: *715 + repositories: &734 description: An array of repository objects that the installation can access. type: array @@ -123953,8 +123658,8 @@ x-webhooks: - name - full_name - private - repository: *717 - requester: *734 + repository: *716 + requester: *733 sender: *4 required: - action @@ -124029,11 +123734,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124109,11 +123814,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124189,10 +123894,10 @@ x-webhooks: type: string enum: - added - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories_added: &736 + organization: *715 + repositories_added: &735 description: An array of repository objects, which were added to the installation. type: array @@ -124238,15 +123943,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *717 - repository_selection: &737 + repository: *716 + repository_selection: &736 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *734 + requester: *733 sender: *4 required: - action @@ -124325,10 +124030,10 @@ x-webhooks: type: string enum: - removed - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories_added: *736 + organization: *715 + repositories_added: *735 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124355,9 +124060,9 @@ x-webhooks: - name - full_name - private - repository: *717 - repository_selection: *737 - requester: *734 + repository: *716 + repository_selection: *736 + requester: *733 sender: *4 required: - action @@ -124436,11 +124141,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124618,10 +124323,10 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 target_type: type: string @@ -124700,11 +124405,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124956,8 +124661,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125751,8 +125456,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125768,7 +125473,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -126101,8 +125806,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -126182,7 +125887,7 @@ x-webhooks: type: string enum: - deleted - comment: &738 + comment: &737 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126347,8 +126052,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127138,8 +126843,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127155,7 +126860,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -127490,8 +127195,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -127571,7 +127276,7 @@ x-webhooks: type: string enum: - edited - changes: &767 + changes: &766 description: The changes to the comment. type: object properties: @@ -127583,9 +127288,9 @@ x-webhooks: type: string required: - from - comment: *738 - enterprise: *714 - installation: *715 + comment: *737 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128378,8 +128083,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128395,7 +128100,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -128728,8 +128433,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -128819,9 +128524,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -128915,9 +128620,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129010,9 +128715,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129106,9 +128811,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129193,10 +128898,10 @@ x-webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - issue: &741 + assignee: *733 + enterprise: *713 + installation: *714 + issue: &740 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -129985,11 +129690,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130005,7 +129710,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -130106,8 +129811,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -130187,8 +129892,8 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130982,11 +130687,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131002,7 +130707,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -131238,8 +130943,8 @@ x-webhooks: required: - state - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -131318,8 +131023,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132104,11 +131809,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132124,7 +131829,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -132224,8 +131929,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -132304,8 +132009,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133112,11 +132817,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133132,7 +132837,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -133211,7 +132916,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &739 + milestone: &738 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133349,8 +133054,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -133449,8 +133154,8 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134239,11 +133944,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134256,7 +133961,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -134360,9 +134065,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -134442,8 +134147,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135231,11 +134936,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135248,7 +134953,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -135352,9 +135057,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -135434,8 +135139,8 @@ x-webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136247,11 +135952,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136264,7 +135969,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -136345,8 +136050,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -136425,8 +136130,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +136937,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137252,7 +136957,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -137330,9 +137035,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *739 - organization: *716 - repository: *717 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -138200,11 +137905,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138297,7 +138002,7 @@ x-webhooks: required: - login - id - type: *216 + type: *217 required: - id - number @@ -138766,8 +138471,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139556,11 +139261,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139576,7 +139281,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -139676,8 +139381,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -139757,9 +139462,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *714 - installation: *715 - issue: &740 + enterprise: *713 + installation: *714 + issue: &739 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140542,11 +140247,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140562,7 +140267,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -140662,8 +140367,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -140742,8 +140447,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141553,11 +141258,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141651,9 +141356,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *216 - organization: *716 - repository: *717 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -142519,11 +142224,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142539,7 +142244,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -143107,11 +142812,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *714 - installation: *715 - issue: *740 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *739 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143191,12 +142896,12 @@ x-webhooks: type: string enum: - typed - enterprise: *714 - installation: *715 - issue: *741 - type: *216 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143277,7 +142982,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &770 + assignee: &769 title: User type: object nullable: true @@ -143347,11 +143052,11 @@ x-webhooks: required: - login - id - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143430,12 +143135,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - issue: *741 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143515,8 +143220,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144326,11 +144031,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144346,7 +144051,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -144424,8 +144129,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144505,11 +144210,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *714 - installation: *715 - issue: *740 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *739 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144588,12 +144293,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *714 - installation: *715 - issue: *741 - type: *216 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144673,11 +144378,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144755,11 +144460,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144869,11 +144574,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144955,9 +144660,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: &742 + enterprise: *713 + installation: *714 + marketplace_purchase: &741 title: Marketplace Purchase type: object required: @@ -145040,8 +144745,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: &743 + organization: *715 + previous_marketplace_purchase: &742 title: Marketplace Purchase type: object properties: @@ -145121,7 +144826,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145201,10 +144906,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145287,7 +144992,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145369,10 +145074,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145454,7 +145159,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145535,8 +145240,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 marketplace_purchase: title: Marketplace Purchase type: object @@ -145618,9 +145323,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + organization: *715 + previous_marketplace_purchase: *742 + repository: *716 sender: *4 required: - action @@ -145700,12 +145405,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 + previous_marketplace_purchase: *742 + repository: *716 sender: *4 required: - action @@ -145807,11 +145512,11 @@ x-webhooks: type: string required: - to - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -145911,11 +145616,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -145994,11 +145699,11 @@ x-webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146076,11 +145781,11 @@ x-webhooks: type: string enum: - added - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146156,7 +145861,7 @@ x-webhooks: required: - login - id - team: &744 + team: &743 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146379,11 +146084,11 @@ x-webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146460,7 +146165,7 @@ x-webhooks: required: - login - id - team: *744 + team: *743 required: - action - scope @@ -146542,8 +146247,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *715 - merge_group: &746 + installation: *714 + merge_group: &745 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146562,15 +146267,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *745 + head_commit: *744 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146656,10 +146361,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *715 - merge_group: *746 - organization: *716 - repository: *717 + installation: *714 + merge_group: *745 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146732,7 +146437,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *713 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146841,16 +146546,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *715 - organization: *716 + installation: *714 + organization: *715 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -146931,11 +146636,11 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147014,9 +146719,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - milestone: &749 + enterprise: *713 + installation: *714 + milestone: &748 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147153,8 +146858,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147233,11 +146938,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147347,11 +147052,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147431,11 +147136,11 @@ x-webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - milestone: *749 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *748 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147514,11 +147219,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *733 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147597,11 +147302,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *733 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147680,9 +147385,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - membership: &750 + enterprise: *713 + installation: *714 + membership: &749 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147789,8 +147494,8 @@ x-webhooks: - role - organization_url - user - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147868,11 +147573,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147951,8 +147656,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148068,10 +147773,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 - user: *734 + user: *733 required: - action - invitation @@ -148149,11 +147854,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -148240,11 +147945,11 @@ x-webhooks: properties: from: type: string - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -148320,9 +148025,9 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 package: description: Information about the package. type: object @@ -148821,7 +148526,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &751 + items: &750 title: Ruby Gems metadata type: object properties: @@ -148916,7 +148621,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -148992,9 +148697,9 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 package: description: Information about the package. type: object @@ -149347,7 +149052,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *751 + items: *750 source_url: type: string format: uri @@ -149417,7 +149122,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -149594,12 +149299,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *714 + enterprise: *713 id: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - id @@ -149676,7 +149381,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &752 + personal_access_token_request: &751 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149822,10 +149527,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *714 - organization: *716 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -149902,11 +149607,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *752 - enterprise: *714 - organization: *716 + personal_access_token_request: *751 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -149982,11 +149687,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *752 - enterprise: *714 - organization: *716 + personal_access_token_request: *751 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -150061,11 +149766,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *752 - organization: *716 - enterprise: *714 + personal_access_token_request: *751 + organization: *715 + enterprise: *713 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -150170,7 +149875,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *753 + last_response: *752 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150202,8 +149907,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 zen: description: Random string of GitHub zen. @@ -150448,10 +150153,10 @@ x-webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: &754 + enterprise: *713 + installation: *714 + organization: *715 + project_card: &753 title: Project Card type: object properties: @@ -150570,7 +150275,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -150651,11 +150356,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_card: *754 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_card: *753 + repository: *716 sender: *4 required: - action @@ -150735,9 +150440,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 project_card: title: Project Card type: object @@ -150865,8 +150570,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -150960,11 +150665,11 @@ x-webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: *754 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_card: *753 + repository: *716 sender: *4 required: - action @@ -151058,9 +150763,9 @@ x-webhooks: - from required: - column_id - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 project_card: allOf: - title: Project Card @@ -151250,7 +150955,7 @@ x-webhooks: type: string required: - after_id - repository: *717 + repository: *716 sender: *4 required: - action @@ -151330,10 +151035,10 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - organization: *716 - project: &756 + enterprise: *713 + installation: *714 + organization: *715 + project: &755 title: Project type: object properties: @@ -151457,7 +151162,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -151537,10 +151242,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_column: &755 + enterprise: *713 + installation: *714 + organization: *715 + project_column: &754 title: Project Column type: object properties: @@ -151579,7 +151284,7 @@ x-webhooks: - name - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -151658,18 +151363,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -151759,11 +151464,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 + repository: *716 sender: *4 required: - action @@ -151843,11 +151548,11 @@ x-webhooks: type: string enum: - moved - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 + repository: *716 sender: *4 required: - action @@ -151927,11 +151632,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152011,18 +151716,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project: *756 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -152124,11 +151829,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152207,11 +151912,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152292,8 +151997,8 @@ x-webhooks: type: string enum: - closed - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152375,8 +152080,8 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152458,8 +152163,8 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152577,8 +152282,8 @@ x-webhooks: type: string to: type: string - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152662,7 +152367,7 @@ x-webhooks: type: string enum: - archived - changes: &760 + changes: &759 type: object properties: archived_at: @@ -152676,9 +152381,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *715 - organization: *716 - projects_v2_item: &757 + installation: *714 + organization: *715 + projects_v2_item: &756 title: Projects v2 Item description: An item belonging to a project type: object @@ -152813,9 +152518,9 @@ x-webhooks: nullable: true to: type: string - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -152897,9 +152602,9 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -152980,9 +152685,9 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153088,7 +152793,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &758 + - &757 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153110,7 +152815,7 @@ x-webhooks: required: - id - name - - &759 + - &758 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153144,8 +152849,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *757 - *758 - - *759 required: - field_value - type: object @@ -153161,9 +152866,9 @@ x-webhooks: nullable: true required: - body - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153258,9 +152963,9 @@ x-webhooks: to: type: string nullable: true - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153343,10 +153048,10 @@ x-webhooks: type: string enum: - restored - changes: *760 - installation: *715 - organization: *716 - projects_v2_item: *757 + changes: *759 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153428,8 +153133,8 @@ x-webhooks: type: string enum: - reopened - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -153511,14 +153216,14 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_status_update: &763 + installation: *714 + organization: *715 + projects_v2_status_update: &762 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *761 - required: *762 + properties: *760 + required: *761 sender: *4 required: - action @@ -153599,9 +153304,9 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_status_update: *763 + installation: *714 + organization: *715 + projects_v2_status_update: *762 sender: *4 required: - action @@ -153737,9 +153442,9 @@ x-webhooks: type: string format: date nullable: true - installation: *715 - organization: *716 - projects_v2_status_update: *763 + installation: *714 + organization: *715 + projects_v2_status_update: *762 sender: *4 required: - action @@ -153810,10 +153515,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - repository @@ -153890,13 +153595,13 @@ x-webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - number: &764 + assignee: *733 + enterprise: *713 + installation: *714 + number: &763 description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -156179,7 +155884,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -156261,11 +155966,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -158543,7 +158248,7 @@ x-webhooks: - draft reason: type: string - repository: *717 + repository: *716 sender: *4 required: - action @@ -158625,11 +158330,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -160907,7 +160612,7 @@ x-webhooks: - draft reason: type: string - repository: *717 + repository: *716 sender: *4 required: - action @@ -160989,13 +160694,13 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: &765 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: &764 allOf: - - *569 + - *568 - type: object properties: allow_auto_merge: @@ -161057,7 +160762,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *717 + repository: *716 sender: *4 required: - action @@ -161138,12 +160843,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -161223,11 +160928,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *714 - milestone: *551 - number: *764 - organization: *716 - pull_request: &766 + enterprise: *713 + milestone: *550 + number: *763 + organization: *715 + pull_request: &765 title: Pull Request type: object properties: @@ -163490,7 +163195,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -163569,11 +163274,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -165855,7 +165560,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *717 + repository: *716 sender: *4 required: - action @@ -165979,12 +165684,12 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -166064,11 +165769,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -168335,7 +168040,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -168415,11 +168120,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 - label: *733 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + label: *732 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -170701,7 +170406,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -170782,10 +170487,10 @@ x-webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -173065,7 +172770,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -173145,12 +172850,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *714 - milestone: *551 - number: *764 - organization: *716 - pull_request: *766 - repository: *717 + enterprise: *713 + milestone: *550 + number: *763 + organization: *715 + pull_request: *765 + repository: *716 sender: *4 required: - action @@ -173229,12 +172934,12 @@ x-webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173315,12 +173020,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173400,12 +173105,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173771,9 +173476,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -175943,7 +175648,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -176023,7 +175728,7 @@ x-webhooks: type: string enum: - deleted - comment: &768 + comment: &767 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176308,9 +176013,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -178468,7 +178173,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -178548,11 +178253,11 @@ x-webhooks: type: string enum: - edited - changes: *767 - comment: *768 - enterprise: *714 - installation: *715 - organization: *716 + changes: *766 + comment: *767 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -180713,7 +180418,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -180794,9 +180499,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -182969,7 +182674,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 review: description: The review that was affected. type: object @@ -183216,9 +182921,9 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -185272,8 +184977,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: &769 + repository: *716 + review: &768 description: The review that was affected. type: object properties: @@ -185506,12 +185211,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -187794,7 +187499,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_reviewer: title: User type: object @@ -187878,12 +187583,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -190173,7 +189878,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190365,12 +190070,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -192655,7 +192360,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_reviewer: title: User type: object @@ -192740,12 +192445,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -195021,7 +194726,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195202,9 +194907,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -197379,8 +197084,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: *769 + repository: *716 + review: *768 sender: *4 required: - action @@ -197460,9 +197165,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -199532,7 +199237,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 sender: *4 thread: type: object @@ -199919,9 +199624,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -201977,7 +201682,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 sender: *4 thread: type: object @@ -202367,10 +202072,10 @@ x-webhooks: type: string before: type: string - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -204641,7 +204346,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -204723,11 +204428,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *770 - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + assignee: *769 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -207010,7 +206715,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -207089,11 +206794,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - label: *733 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + label: *732 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -209366,7 +209071,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -209447,10 +209152,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -211715,7 +211420,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -211915,7 +211620,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *714 + enterprise: *713 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212007,8 +211712,8 @@ x-webhooks: - url - author - committer - installation: *715 - organization: *716 + installation: *714 + organization: *715 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212583,9 +212288,9 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 registry_package: type: object properties: @@ -213031,7 +212736,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *751 + items: *750 summary: type: string tag_name: @@ -213085,7 +212790,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -213163,9 +212868,9 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 registry_package: type: object properties: @@ -213473,7 +213178,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *751 + items: *750 summary: type: string tag_name: @@ -213522,7 +213227,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -213599,10 +213304,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - release: &771 + enterprise: *713 + installation: *714 + organization: *715 + release: &770 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213920,7 +213625,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *717 + repository: *716 sender: *4 required: - action @@ -213997,11 +213702,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -214118,11 +213823,11 @@ x-webhooks: type: boolean required: - to - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -214200,9 +213905,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214524,7 +214229,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *717 + repository: *716 sender: *4 required: - action @@ -214600,10 +214305,10 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - release: &772 + enterprise: *713 + installation: *714 + organization: *715 + release: &771 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214922,7 +214627,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *717 + repository: *716 sender: *4 required: - action @@ -214998,11 +214703,11 @@ x-webhooks: type: string enum: - released - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -215078,11 +214783,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *714 - installation: *715 - organization: *716 - release: *772 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *771 + repository: *716 sender: *4 required: - action @@ -215158,11 +214863,11 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *633 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + repository_advisory: *632 sender: *4 required: - action @@ -215238,11 +214943,11 @@ x-webhooks: type: string enum: - reported - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *633 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + repository_advisory: *632 sender: *4 required: - action @@ -215318,10 +215023,10 @@ x-webhooks: type: string enum: - archived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215398,10 +215103,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215479,10 +215184,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215566,10 +215271,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215681,10 +215386,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215756,10 +215461,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 status: type: string @@ -215840,10 +215545,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215920,10 +215625,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216017,10 +215722,10 @@ x-webhooks: - name required: - repository - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216100,10 +215805,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 sender: *4 required: @@ -216182,10 +215887,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 sender: *4 required: @@ -216264,10 +215969,10 @@ x-webhooks: type: string enum: - edited - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 changes: type: object @@ -216329,16 +216034,16 @@ x-webhooks: properties: added: type: array - items: *590 + items: *589 deleted: type: array - items: *590 + items: *589 updated: type: array items: type: object properties: - rule: *590 + rule: *589 changes: type: object properties: @@ -216572,10 +216277,10 @@ x-webhooks: - from required: - owner - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216653,10 +216358,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216734,7 +216439,7 @@ x-webhooks: type: string enum: - create - alert: &773 + alert: &772 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216855,10 +216560,10 @@ x-webhooks: type: string enum: - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217064,10 +216769,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217145,11 +216850,11 @@ x-webhooks: type: string enum: - reopen - alert: *773 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *772 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217348,10 +217053,10 @@ x-webhooks: enum: - fixed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217429,11 +217134,11 @@ x-webhooks: type: string enum: - created - alert: &774 + alert: &773 type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217441,8 +217146,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri @@ -217547,10 +217252,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217631,11 +217336,11 @@ x-webhooks: type: string enum: - created - alert: *774 - installation: *715 - location: *775 - organization: *716 - repository: *717 + alert: *773 + installation: *714 + location: *774 + organization: *715 + repository: *716 sender: *4 required: - location @@ -217873,11 +217578,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217955,11 +217660,11 @@ x-webhooks: type: string enum: - reopened - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218037,11 +217742,11 @@ x-webhooks: type: string enum: - resolved - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218119,11 +217824,11 @@ x-webhooks: type: string enum: - validated - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218249,10 +217954,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *717 - enterprise: *714 - installation: *715 - organization: *716 + repository: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -218330,11 +218035,11 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: &776 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + security_advisory: &775 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218517,11 +218222,11 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: *776 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + security_advisory: *775 sender: *4 required: - action @@ -218594,10 +218299,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218782,10 +218487,10 @@ x-webhooks: type: object properties: security_and_analysis: *269 - enterprise: *714 - installation: *715 - organization: *716 - repository: *332 + enterprise: *713 + installation: *714 + organization: *715 + repository: *330 sender: *4 required: - changes @@ -218863,12 +218568,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: &777 + sponsorship: &776 type: object properties: created_at: @@ -219169,12 +218874,12 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - sponsorship @@ -219262,12 +218967,12 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219344,17 +219049,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &778 + effective_date: &777 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: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - sponsorship @@ -219428,7 +219133,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &779 + changes: &778 type: object properties: tier: @@ -219472,13 +219177,13 @@ x-webhooks: - from required: - tier - effective_date: *778 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + effective_date: *777 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219555,13 +219260,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *779 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + changes: *778 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219635,10 +219340,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219721,10 +219426,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220144,15 +219849,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *714 + enterprise: *713 id: description: The unique identifier of the status. type: integer - installation: *715 + installation: *714 name: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 sha: description: The Commit SHA. @@ -220267,9 +219972,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220359,9 +220064,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220451,9 +220156,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220543,9 +220248,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220622,12 +220327,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - team: &780 + team: &779 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220850,9 +220555,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -221310,7 +221015,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -221386,9 +221091,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -221846,7 +221551,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -221923,9 +221628,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -222383,7 +222088,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -222527,9 +222232,9 @@ x-webhooks: - from required: - permissions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -222987,7 +222692,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - changes @@ -223065,9 +222770,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -223525,7 +223230,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -223601,10 +223306,10 @@ x-webhooks: type: string enum: - started - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -223677,16 +223382,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *714 + enterprise: *713 inputs: type: object nullable: true additionalProperties: true - installation: *715 - organization: *716 + installation: *714 + organization: *715 ref: type: string - repository: *717 + repository: *716 sender: *4 workflow: type: string @@ -223768,10 +223473,10 @@ x-webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: allOf: @@ -224008,7 +223713,7 @@ x-webhooks: type: string required: - conclusion - deployment: *483 + deployment: *481 required: - action - repository @@ -224087,10 +223792,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: allOf: @@ -224350,7 +224055,7 @@ x-webhooks: required: - status - steps - deployment: *483 + deployment: *481 required: - action - repository @@ -224429,10 +224134,10 @@ x-webhooks: type: string enum: - queued - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: type: object @@ -224567,7 +224272,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *483 + deployment: *481 required: - action - repository @@ -224646,10 +224351,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: type: object @@ -224785,7 +224490,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *483 + deployment: *481 required: - action - repository @@ -224865,12 +224570,12 @@ x-webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object @@ -225869,12 +225574,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object @@ -226858,12 +226563,12 @@ x-webhooks: type: string enum: - requested - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index ca4a91a37..af18eac52 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -53382,6 +53382,1264 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -54063,7 +55321,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" @@ -54071,7 +55329,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": [ { @@ -54140,7 +55398,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -128629,847 +129887,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -180891,965 +181308,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -406507,1193 +405965,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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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" - } - } - } - } - } + } + }, + "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" + } }, - "403": { - "description": "Forbidden", + { + "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": { @@ -407715,11 +406057,88 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" + } }, - "404": { - "description": "Resource not found", + { + "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": { @@ -407741,11 +406160,88 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" + } }, - "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": { + "204": { + "description": "A header with no content is returned." + }, + "422": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -407767,29 +406263,33 @@ } } } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { + }, + "application/scim+json": { "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", + "title": "Scim Error", + "description": "Scim Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { - "type": "string" + "type": "string", + "nullable": true }, "documentation_url": { - "type": "string" + "type": "string", + "nullable": true }, - "errors": { + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -407804,12 +406304,9 @@ "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": { @@ -464864,8 +463361,12 @@ "nullable": true } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -550742,416 +549243,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -581833,421 +579924,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", @@ -605411,7 +603087,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" @@ -605419,7 +603095,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": [ { @@ -605488,7 +603164,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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 82185a526..607d40cbf 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -990,7 +990,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &112 + schema: &113 title: Validation Error Simple description: Validation Error Simple type: object @@ -1023,7 +1023,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &635 + - &634 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1579,7 +1579,7 @@ paths: schema: type: integer default: 30 - - &194 + - &195 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1595,7 +1595,7 @@ paths: application/json: schema: type: array - items: &195 + items: &196 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1675,7 +1675,7 @@ paths: - installation_id - repository_id examples: - default: &196 + default: &197 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1734,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &111 + schema: &112 title: Validation Error description: Validation Error type: object @@ -1803,7 +1803,7 @@ paths: description: Response content: application/json: - schema: &197 + schema: &198 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1917,7 +1917,7 @@ paths: - request - response examples: - default: &198 + default: &199 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -7414,7 +7414,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &168 + code_scanning_options: &169 type: object description: Security Configuration feature options for code scanning nullable: true @@ -7608,7 +7608,7 @@ paths: description: Response content: application/json: - schema: &170 + schema: &171 type: array description: A list of default code security configurations items: @@ -7624,7 +7624,7 @@ paths: default configuration: *43 examples: - default: &171 + default: &172 value: - default_for_new_repos: public configuration: @@ -7955,7 +7955,7 @@ paths: - *42 - *45 responses: - '204': &172 + '204': &173 description: A header with no content is returned. '400': *14 '403': *29 @@ -8082,7 +8082,7 @@ paths: default: value: default_for_new_repos: all - configuration: &169 + configuration: &170 value: id: 1325 target_type: organization @@ -8167,7 +8167,7 @@ paths: application/json: schema: type: array - items: &173 + items: &174 type: object description: Repositories associated with a code security configuration and attachment status @@ -8468,7 +8468,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &174 + repository: &175 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8562,7 +8562,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *42 - - &179 + - &180 name: state in: query description: |- @@ -8571,7 +8571,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &180 + - &181 name: severity in: query description: |- @@ -8580,7 +8580,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &181 + - &182 name: ecosystem in: query description: |- @@ -8589,14 +8589,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &182 + - &183 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 - - &183 + - &184 name: epss_percentage in: query description: |- @@ -8608,7 +8608,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &474 + - &472 name: has in: query description: |- @@ -8622,7 +8622,7 @@ paths: type: string enum: - patch - - &184 + - &185 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8632,7 +8632,7 @@ paths: enum: - development - runtime - - &185 + - &186 name: sort in: query description: |- @@ -8658,11 +8658,11 @@ paths: application/json: schema: type: array - items: &186 + items: &187 type: object description: A Dependabot alert. properties: - number: &158 + number: &159 type: integer description: The security alert number. readOnly: true @@ -8724,7 +8724,7 @@ paths: - unknown - direct - transitive - security_advisory: &475 + security_advisory: &473 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8927,29 +8927,29 @@ paths: - withdrawn_at additionalProperties: false security_vulnerability: *52 - url: &161 + url: &162 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &162 + html_url: &163 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &159 + created_at: &160 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: &160 + updated_at: &161 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: &164 + dismissed_at: &165 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8979,14 +8979,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &163 + fixed_at: &164 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &476 + auto_dismissed_at: &474 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -9012,7 +9012,7 @@ paths: - repository additionalProperties: false examples: - default: &187 + default: &188 value: - number: 2 state: dismissed @@ -9796,7 +9796,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &176 + properties: &177 login: type: string example: github @@ -9837,7 +9837,7 @@ paths: type: string example: A great organization nullable: true - required: &177 + required: &178 - login - url - id @@ -10282,7 +10282,7 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &524 + properties: &523 id: type: integer format: int64 @@ -10543,7 +10543,7 @@ paths: timeline_url: type: string format: uri - type: &216 + type: &217 title: Issue Type description: The type of issue. type: object @@ -10654,7 +10654,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &647 + sub_issues_summary: &646 title: Sub-issues Summary type: object properties: @@ -10674,7 +10674,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &648 + issue_dependencies_summary: &647 title: Issue Dependencies Summary type: object properties: @@ -10693,7 +10693,7 @@ paths: - total_blocking issue_field_values: type: array - items: &649 + items: &648 title: Issue Field Value description: A value assigned to an issue field type: object @@ -10753,7 +10753,7 @@ paths: - node_id - data_type - value - required: &525 + required: &524 - assignee - closed_at - comments @@ -10774,7 +10774,7 @@ paths: - user - created_at - updated_at - comment: &522 + comment: &521 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11344,7 +11344,7 @@ paths: url: type: string format: uri - user: &661 + user: &660 title: Public User description: Public User type: object @@ -13214,7 +13214,7 @@ paths: - closed - all default: open - - &219 + - &220 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13265,7 +13265,7 @@ paths: type: array items: *82 examples: - default: &220 + default: &221 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14719,7 +14719,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &333 + '301': &331 description: Moved permanently content: application/json: @@ -14741,7 +14741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &554 + - &553 name: all description: If `true`, show notifications marked as read. in: query @@ -14749,7 +14749,7 @@ paths: schema: type: boolean default: false - - &555 + - &554 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14759,7 +14759,7 @@ paths: type: boolean default: false - *72 - - &556 + - &555 name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: @@ -14791,11 +14791,11 @@ paths: properties: id: type: string - repository: &142 + repository: &143 title: Minimal Repository description: Minimal Repository type: object - properties: &189 + properties: &190 id: type: integer format: int64 @@ -15145,7 +15145,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &190 + required: &191 - archive_url - assignees_url - blobs_url @@ -15233,7 +15233,7 @@ paths: - url - subscription_url examples: - default: &557 + default: &556 value: - id: '1' repository: @@ -16101,7 +16101,7 @@ paths: - property_name - value examples: - default: &563 + default: &562 value: - property_name: environment value: production @@ -16151,7 +16151,7 @@ paths: required: - properties examples: - default: &564 + default: &563 value: properties: - property_name: environment @@ -16172,6 +16172,482 @@ 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: + - *63 + 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 + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - 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': *29 + '500': *103 + 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: + - *63 + - &105 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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': *29 + '500': *103 + '503': *104 + 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: + - *63 + - *105 + 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 + example: 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': *25 + '403': *29 + '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: + - *63 + - *105 + 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': *29 + '500': *103 + '503': *104 + 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 @@ -16187,7 +16663,7 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *63 - - &105 + - &106 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, @@ -16196,7 +16672,7 @@ paths: required: false schema: type: integer - - &107 + - &108 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 @@ -16205,7 +16681,7 @@ paths: required: false schema: type: integer - - &106 + - &107 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 @@ -16220,14 +16696,14 @@ paths: required: false schema: type: string - - &705 + - &704 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &108 + - &109 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -16365,8 +16841,8 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *63 - - *105 - - &708 + - *106 + - &707 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the @@ -16375,7 +16851,7 @@ paths: required: false schema: type: integer - - *106 + - *107 responses: '200': description: Billing usage report response for an organization @@ -16459,7 +16935,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. @@ -16472,21 +16948,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: - *63 - - *105 - - *107 - *106 - - &709 + - *108 + - *107 + - &708 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *108 - - &710 + - *109 + - &709 name: sku description: The SKU to query for usage. in: query @@ -16495,7 +16971,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: @@ -16629,7 +17105,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &110 title: Organization Full description: Organization Full type: object @@ -16948,7 +17424,7 @@ paths: - updated_at - archived_at examples: - default-response: &110 + default-response: &111 value: login: github id: 1 @@ -17264,17 +17740,17 @@ paths: description: Response content: application/json: - schema: *109 + schema: *110 examples: - default: *110 + default: *111 '422': description: Validation failed content: application/json: schema: oneOf: - - *111 - *112 + - *113 '409': *47 x-github: githubCloudOnly: false @@ -17388,7 +17864,7 @@ paths: type: integer repository_cache_usages: type: array - items: &338 + items: &336 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -17461,7 +17937,7 @@ paths: type: integer runners: type: array - items: &113 + items: &114 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -17515,7 +17991,7 @@ paths: - display_name - source nullable: true - machine_size_details: &121 + machine_size_details: &122 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -17611,7 +18087,7 @@ paths: - public_ip_enabled - platform examples: - default: &141 + default: &142 value: total_count: 2 runners: @@ -17748,9 +18224,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: &122 + default: &123 value: id: 5 name: My hosted ubuntu runner @@ -17807,7 +18283,7 @@ paths: type: integer images: type: array - items: &114 + items: &115 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -17858,7 +18334,7 @@ paths: - latest_version - state examples: - default: &116 + default: &117 value: total_count: 2 image_versions: @@ -17890,7 +18366,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners parameters: - *63 - - &115 + - &116 name: image_definition_id description: Image definition ID of custom image in: path @@ -17902,7 +18378,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *115 examples: default: value: @@ -17933,7 +18409,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - *63 - - *115 + - *116 responses: '204': description: Response @@ -17956,7 +18432,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: - - *115 + - *116 - *63 responses: '200': @@ -17973,7 +18449,7 @@ paths: type: integer image_versions: type: array - items: &117 + items: &118 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -18006,7 +18482,7 @@ paths: - created_on - state_details examples: - default: *116 + default: *117 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18027,8 +18503,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: - *63 - - *115 - - &118 + - *116 + - &119 name: version description: Version of a custom image in: path @@ -18041,7 +18517,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *118 examples: default: value: @@ -18068,8 +18544,8 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization parameters: - *63 - - *115 - - *118 + - *116 + - *119 responses: '204': description: Response @@ -18106,7 +18582,7 @@ paths: type: integer images: type: array - items: &119 + items: &120 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -18142,7 +18618,7 @@ paths: - display_name - source examples: - default: &120 + default: &121 value: id: ubuntu-20.04 platform: linux-x64 @@ -18182,9 +18658,9 @@ paths: type: integer images: type: array - items: *119 + items: *120 examples: - default: *120 + default: *121 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18270,7 +18746,7 @@ paths: type: integer machine_specs: type: array - items: *121 + items: *122 examples: default: value: @@ -18340,7 +18816,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - *63 - - &123 + - &124 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -18352,9 +18828,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 headers: Link: *54 x-github: @@ -18375,7 +18851,7 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - *63 - - *123 + - *124 requestBody: required: true content: @@ -18418,9 +18894,9 @@ paths: description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18437,15 +18913,15 @@ paths: url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - *63 - - *123 + - *124 responses: '202': description: Response content: application/json: - schema: *113 + schema: *114 examples: - default: *122 + default: *123 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -18471,7 +18947,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &124 + schema: &125 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -18485,7 +18961,7 @@ paths: required: - include_claim_keys examples: - default: &125 + default: &126 value: include_claim_keys: - repo @@ -18512,15 +18988,15 @@ paths: required: true content: application/json: - schema: *124 + schema: *125 examples: - default: *125 + default: *126 responses: '201': description: Empty response content: application/json: - schema: &151 + schema: &152 title: Empty Object description: An object without any properties. type: object @@ -18559,7 +19035,7 @@ paths: schema: type: object properties: - enabled_repositories: &126 + enabled_repositories: &127 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -18572,7 +19048,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: &127 + allowed_actions: &128 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -18580,12 +19056,12 @@ paths: - all - local_only - selected - selected_actions_url: &344 + selected_actions_url: &342 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: &128 + sha_pinning_required: &129 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -18627,9 +19103,9 @@ paths: schema: type: object properties: - enabled_repositories: *126 - allowed_actions: *127 - sha_pinning_required: *128 + enabled_repositories: *127 + allowed_actions: *128 + sha_pinning_required: *129 required: - enabled_repositories examples: @@ -18663,7 +19139,7 @@ paths: description: Response content: application/json: - schema: &348 + schema: &346 type: object properties: days: @@ -18705,7 +19181,7 @@ paths: required: true content: application/json: - schema: &349 + schema: &347 type: object properties: days: @@ -18748,7 +19224,7 @@ paths: description: Response content: application/json: - schema: &129 + schema: &130 type: object properties: approval_policy: @@ -18762,7 +19238,7 @@ paths: required: - approval_policy examples: - default: &350 + default: &348 value: approval_policy: first_time_contributors '404': *6 @@ -18793,7 +19269,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *130 examples: default: summary: Set approval policy to first time contributors @@ -18821,7 +19297,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &349 type: object required: - run_workflows_from_fork_pull_requests @@ -18847,7 +19323,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &130 + default: &131 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -18875,7 +19351,7 @@ paths: required: true content: application/json: - schema: &352 + schema: &350 type: object required: - run_workflows_from_fork_pull_requests @@ -18898,7 +19374,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *130 + default: *131 responses: '204': description: Empty response for successful settings update @@ -18948,7 +19424,7 @@ paths: type: array items: *66 examples: - default: &134 + default: &135 value: total_count: 1 repositories: @@ -19133,7 +19609,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *63 - - &131 + - &132 name: repository_id description: The unique identifier of the repository. in: path @@ -19162,7 +19638,7 @@ paths: url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -19191,7 +19667,7 @@ paths: description: Response content: application/json: - schema: &132 + schema: &133 type: object properties: github_owned_allowed: @@ -19213,7 +19689,7 @@ paths: items: type: string examples: - default: &133 + default: &134 value: github_owned_allowed: true verified_allowed: false @@ -19246,9 +19722,9 @@ paths: required: false content: application/json: - schema: *132 + schema: *133 examples: - selected_actions: *133 + selected_actions: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19380,7 +19856,7 @@ paths: type: array items: *66 examples: - default: *134 + default: *135 '403': *29 '404': *6 x-github: @@ -19449,7 +19925,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: - *63 - - *131 + - *132 responses: '204': description: No content @@ -19476,7 +19952,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: - *63 - - *131 + - *132 responses: '204': description: No content @@ -19510,17 +19986,17 @@ paths: description: Response content: application/json: - schema: &353 + schema: &351 type: object properties: - default_workflow_permissions: &135 + default_workflow_permissions: &136 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &136 + can_approve_pull_request_reviews: &137 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -19528,7 +20004,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &137 + default: &138 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -19561,13 +20037,13 @@ paths: required: false content: application/json: - schema: &354 + schema: &352 type: object properties: - default_workflow_permissions: *135 - can_approve_pull_request_reviews: *136 + default_workflow_permissions: *136 + can_approve_pull_request_reviews: *137 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19612,7 +20088,7 @@ paths: type: number runner_groups: type: array - items: &138 + items: &139 type: object properties: id: @@ -19800,9 +20276,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: &140 + default: &141 value: id: 2 name: octo-runner-group @@ -19838,7 +20314,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - *63 - - &139 + - &140 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -19850,7 +20326,7 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: default: value: @@ -19887,7 +20363,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - *63 - - *139 + - *140 requestBody: required: true content: @@ -19941,9 +20417,9 @@ paths: description: Response content: application/json: - schema: *138 + schema: *139 examples: - default: *140 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19963,7 +20439,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - *63 - - *139 + - *140 responses: '204': description: Response @@ -19987,7 +20463,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 - *17 - *19 responses: @@ -20005,9 +20481,9 @@ paths: type: number runners: type: array - items: *113 + items: *114 examples: - default: *141 + default: *142 headers: Link: *54 x-github: @@ -20030,7 +20506,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: - *63 - - *139 + - *140 - *19 - *17 responses: @@ -20048,9 +20524,9 @@ paths: type: number repositories: type: array - items: *142 + items: *143 examples: - default: &664 + default: &663 value: total_count: 1 repositories: @@ -20303,7 +20779,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: - *63 - - *139 + - *140 requestBody: required: true content: @@ -20348,8 +20824,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: - *63 - - *139 - - *131 + - *140 + - *132 responses: '204': description: Response @@ -20372,8 +20848,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: - *63 - - *139 - - *131 + - *140 + - *132 responses: '204': description: Response @@ -20397,7 +20873,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 - *17 - *19 responses: @@ -20415,7 +20891,7 @@ paths: type: number runners: type: array - items: &144 + items: &145 title: Self hosted runners description: A self hosted runner type: object @@ -20444,7 +20920,7 @@ paths: type: boolean labels: type: array - items: &147 + items: &148 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -20474,7 +20950,7 @@ paths: - busy - labels examples: - default: &145 + default: &146 value: total_count: 2 runners: @@ -20534,7 +21010,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - *63 - - *139 + - *140 requestBody: required: true content: @@ -20579,8 +21055,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: - *63 - - *139 - - &143 + - *140 + - &144 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -20609,8 +21085,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: - *63 - - *139 - - *143 + - *140 + - *144 responses: '204': description: Response @@ -20658,9 +21134,9 @@ paths: type: integer runners: type: array - items: *144 + items: *145 examples: - default: *145 + default: *146 headers: Link: *54 x-github: @@ -20692,7 +21168,7 @@ paths: application/json: schema: type: array - items: &355 + items: &353 title: Runner Application description: Runner Application type: object @@ -20717,7 +21193,7 @@ paths: - download_url - filename examples: - default: &356 + default: &354 value: - os: osx architecture: x64 @@ -20803,7 +21279,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &357 + '201': &355 description: Response content: application/json: @@ -20813,7 +21289,7 @@ paths: - runner - encoded_jit_config properties: - runner: *144 + runner: *145 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -20876,7 +21352,7 @@ paths: description: Response content: application/json: - schema: &146 + schema: &147 title: Authentication Token description: Authentication Token type: object @@ -20914,7 +21390,7 @@ paths: - token - expires_at examples: - default: &358 + default: &356 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -20951,9 +21427,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: &359 + default: &357 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -20979,15 +21455,15 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: &360 + default: &358 value: id: 23 name: MBP @@ -21029,7 +21505,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - *63 - - *143 + - *144 responses: '204': description: Response @@ -21056,9 +21532,9 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 responses: - '200': &148 + '200': &149 description: Response content: application/json: @@ -21072,7 +21548,7 @@ paths: type: integer labels: type: array - items: *147 + items: *148 examples: default: value: @@ -21112,7 +21588,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 requestBody: required: true content: @@ -21136,7 +21612,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21161,7 +21637,7 @@ paths: url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - *63 - - *143 + - *144 requestBody: required: true content: @@ -21186,7 +21662,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21211,9 +21687,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: - *63 - - *143 + - *144 responses: - '200': &361 + '200': &359 description: Response content: application/json: @@ -21227,7 +21703,7 @@ paths: type: integer labels: type: array - items: *147 + items: *148 examples: default: value: @@ -21269,8 +21745,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: - *63 - - *143 - - &362 + - *144 + - &360 name: name description: The name of a self-hosted runner's custom label. in: path @@ -21278,7 +21754,7 @@ paths: schema: type: string responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -21321,7 +21797,7 @@ paths: type: integer secrets: type: array - items: &149 + items: &150 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21400,7 +21876,7 @@ paths: description: Response content: application/json: - schema: &374 + schema: &372 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21429,7 +21905,7 @@ paths: - key_id - key examples: - default: &375 + default: &373 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21455,7 +21931,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - *63 - - &150 + - &151 name: secret_name description: The name of the secret. in: path @@ -21467,7 +21943,7 @@ paths: description: Response content: application/json: - schema: *149 + schema: *150 examples: default: value: @@ -21498,7 +21974,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -21555,7 +22031,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -21582,7 +22058,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -21609,7 +22085,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -21627,9 +22103,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: &154 + default: &155 value: total_count: 1 repositories: @@ -21722,7 +22198,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -21775,7 +22251,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -21809,7 +22285,7 @@ paths: url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -21842,7 +22318,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - *63 - - &343 + - &341 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)." @@ -21866,7 +22342,7 @@ paths: type: integer variables: type: array - items: &152 + items: &153 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -21999,7 +22475,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -22025,7 +22501,7 @@ paths: url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - *63 - - &153 + - &154 name: name description: The name of the variable. in: path @@ -22037,7 +22513,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *153 examples: default: value: @@ -22068,7 +22544,7 @@ paths: url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - *63 - - *153 + - *154 requestBody: required: true content: @@ -22131,7 +22607,7 @@ paths: url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - *63 - - *153 + - *154 responses: '204': description: Response @@ -22158,7 +22634,7 @@ paths: url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *63 - - *153 + - *154 - *19 - *17 responses: @@ -22176,9 +22652,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22205,7 +22681,7 @@ paths: url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *63 - - *153 + - *154 requestBody: required: true content: @@ -22255,7 +22731,7 @@ paths: url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *63 - - *153 + - *154 - name: repository_id in: path required: true @@ -22290,7 +22766,7 @@ paths: url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *63 - - *153 + - *154 - name: repository_id in: path required: true @@ -22575,12 +23051,12 @@ paths: required: - subject_digests examples: - default: &692 + default: &691 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &693 + withPredicateType: &692 value: subject_digests: - sha256:abc123 @@ -22638,7 +23114,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &694 + default: &693 value: attestations_subject_digests: - sha256:abc: @@ -22987,7 +23463,7 @@ paths: initiator: type: string examples: - default: &388 + default: &386 value: attestations: - bundle: @@ -23206,7 +23682,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &155 + schema: &156 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -23232,7 +23708,7 @@ paths: application/json: schema: type: array - items: &156 + items: &157 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -23263,7 +23739,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &178 + items: &179 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -23338,7 +23814,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &231 + properties: &232 id: description: Unique identifier of the team type: integer @@ -23410,7 +23886,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &232 + required: &233 - id - node_id - url @@ -23453,7 +23929,7 @@ paths: type: string format: date-time nullable: true - state: *155 + state: *156 contact_link: description: The contact link of the campaign. type: string @@ -23673,9 +24149,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: &157 + default: &158 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -23758,9 +24234,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: *157 + default: *158 '404': *6 '422': description: Unprocessable Entity @@ -23837,7 +24313,7 @@ paths: type: string format: uri nullable: true - state: *155 + state: *156 examples: default: value: @@ -23847,9 +24323,9 @@ paths: description: Response content: application/json: - schema: *156 + schema: *157 examples: - default: *157 + default: *158 '400': description: Bad Request content: @@ -23916,17 +24392,17 @@ paths: url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *63 - - &414 + - &412 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: &165 + schema: &166 type: string description: The name of the tool used to generate the code scanning analysis. - - &415 + - &413 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 @@ -23934,7 +24410,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &166 + schema: &167 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -23949,7 +24425,7 @@ paths: be returned. in: query required: false - schema: &417 + schema: &415 type: string description: State of a code scanning alert. enum: @@ -23972,7 +24448,7 @@ paths: be returned. in: query required: false - schema: &418 + schema: &416 type: string description: Severity of a code scanning alert. enum: @@ -23993,18 +24469,18 @@ paths: items: type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: &419 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: &417 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &167 + state: &168 type: string description: State of a code scanning alert. nullable: true @@ -24012,7 +24488,7 @@ paths: - open - dismissed - fixed - fixed_at: *163 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -24020,8 +24496,8 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: &420 + dismissed_at: *165 + dismissed_reason: &418 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -24030,13 +24506,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &421 + dismissed_comment: &419 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &422 + rule: &420 type: object properties: id: @@ -24089,25 +24565,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &423 + tool: &421 type: object properties: - name: *165 + name: *166 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *166 - most_recent_instance: &424 + guid: *167 + most_recent_instance: &422 type: object properties: - ref: &416 + ref: &414 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &434 + analysis_key: &432 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -24118,13 +24594,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &435 + category: &433 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: *167 + state: *168 commit_sha: type: string message: @@ -24631,7 +25107,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *168 + code_scanning_options: *169 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -24774,7 +25250,7 @@ paths: application/json: schema: *43 examples: - default: *169 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24802,9 +25278,9 @@ paths: description: Response content: application/json: - schema: *170 + schema: *171 examples: - default: *171 + default: *172 '304': *37 '403': *29 '404': *6 @@ -24856,7 +25332,7 @@ paths: - 32 - 91 responses: - '204': *172 + '204': *173 '400': *14 '403': *29 '404': *6 @@ -24891,7 +25367,7 @@ paths: application/json: schema: *43 examples: - default: *169 + default: *170 '304': *37 '403': *29 '404': *6 @@ -25175,7 +25651,7 @@ paths: - *63 - *45 responses: - '204': *172 + '204': *173 '400': *14 '403': *29 '404': *6 @@ -25313,7 +25789,7 @@ paths: default: value: default_for_new_repos: all - configuration: *169 + configuration: *170 '403': *29 '404': *6 x-github: @@ -25366,13 +25842,13 @@ paths: application/json: schema: type: array - items: *173 + items: *174 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *174 + repository: *175 '403': *29 '404': *6 x-github: @@ -25412,7 +25888,7 @@ paths: type: integer codespaces: type: array - items: &221 + items: &222 type: object title: Codespace description: A codespace. @@ -25437,12 +25913,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *142 + repository: *143 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &447 + properties: &445 name: type: string description: The name of the machine. @@ -25484,7 +25960,7 @@ paths: - ready - in_progress nullable: true - required: &448 + required: &446 - name - display_name - operating_system @@ -25689,7 +26165,7 @@ paths: - pulls_url - recent_folders examples: - default: &222 + default: &223 value: total_count: 3 codespaces: @@ -26313,7 +26789,7 @@ paths: type: integer secrets: type: array - items: &175 + items: &176 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26352,7 +26828,7 @@ paths: - updated_at - visibility examples: - default: &449 + default: &447 value: total_count: 2 secrets: @@ -26390,7 +26866,7 @@ paths: description: Response content: application/json: - schema: &450 + schema: &448 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26419,7 +26895,7 @@ paths: - key_id - key examples: - default: &451 + default: &449 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26443,15 +26919,15 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *175 + schema: *176 examples: - default: &453 + default: &451 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26479,7 +26955,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -26534,7 +27010,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -26561,7 +27037,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -26587,7 +27063,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -26605,9 +27081,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 '404': *6 x-github: githubCloudOnly: false @@ -26630,7 +27106,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -26681,7 +27157,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -26715,7 +27191,7 @@ paths: url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -26918,7 +27394,7 @@ paths: currently being billed. seats: type: array - items: &224 + items: &225 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -26935,14 +27411,14 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: *176 - required: *177 + properties: *177 + required: *178 nullable: true assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *178 + - *179 - *55 nullable: true pending_cancellation_date: @@ -27886,11 +28362,11 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *63 - - *179 - *180 - *181 - *182 - *183 + - *184 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -27928,8 +28404,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *184 - *185 + - *186 - *48 - *40 - *41 @@ -27941,9 +28417,9 @@ paths: application/json: schema: type: array - items: *186 + items: *187 examples: - default: *187 + default: *188 '304': *37 '400': *14 '403': *29 @@ -27987,7 +28463,7 @@ paths: type: integer secrets: type: array - items: &188 + items: &189 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -28064,7 +28540,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &477 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -28081,7 +28557,7 @@ paths: - key_id - key examples: - default: &480 + default: &478 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28105,13 +28581,13 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *188 + schema: *189 examples: default: value: @@ -28140,7 +28616,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -28199,7 +28675,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -28224,7 +28700,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -28249,7 +28725,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 - *19 - *17 responses: @@ -28267,9 +28743,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28291,7 +28767,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -28342,7 +28818,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -28374,7 +28850,7 @@ paths: url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *63 - - *150 + - *151 - name: repository_id in: path required: true @@ -28412,7 +28888,7 @@ paths: application/json: schema: type: array - items: &234 + items: &235 title: Package description: A software package type: object @@ -28462,8 +28938,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *189 - required: *190 + properties: *190 + required: *191 nullable: true created_at: type: string @@ -28482,7 +28958,7 @@ paths: - created_at - updated_at examples: - default: &235 + default: &236 value: - id: 197 name: hello_docker @@ -28652,7 +29128,7 @@ paths: application/json: schema: type: array - items: &213 + items: &214 title: Organization Invitation description: Organization Invitation type: object @@ -28699,7 +29175,7 @@ paths: - invitation_teams_url - node_id examples: - default: &214 + default: &215 value: - id: 1 login: monalisa @@ -28766,7 +29242,7 @@ paths: application/json: schema: type: array - items: &191 + items: &192 title: Org Hook description: Org Hook type: object @@ -28937,9 +29413,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: - default: &192 + default: &193 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28987,7 +29463,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - *63 - - &193 + - &194 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. @@ -29000,9 +29476,9 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: - default: *192 + default: *193 '404': *6 x-github: githubCloudOnly: false @@ -29030,7 +29506,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - *63 - - *193 + - *194 requestBody: required: false content: @@ -29075,7 +29551,7 @@ paths: description: Response content: application/json: - schema: *191 + schema: *192 examples: default: value: @@ -29117,7 +29593,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - *63 - - *193 + - *194 responses: '204': description: Response @@ -29145,7 +29621,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *63 - - *193 + - *194 responses: '200': description: Response @@ -29176,7 +29652,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *63 - - *193 + - *194 requestBody: required: false content: @@ -29227,9 +29703,9 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *63 - - *193 - - *17 - *194 + - *17 + - *195 responses: '200': description: Response @@ -29237,9 +29713,9 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '400': *14 '422': *15 x-github: @@ -29265,16 +29741,16 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *63 - - *193 + - *194 - *16 responses: '200': description: Response content: application/json: - schema: *197 + schema: *198 examples: - default: *198 + default: *199 '400': *14 '422': *15 x-github: @@ -29300,7 +29776,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *63 - - *193 + - *194 - *16 responses: '202': *39 @@ -29330,7 +29806,7 @@ paths: url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - *63 - - *193 + - *194 responses: '204': description: Response @@ -29353,7 +29829,7 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - *63 - - &203 + - &204 name: actor_type in: path description: The type of the actor @@ -29366,14 +29842,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &204 + - &205 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &199 + - &200 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`.' @@ -29381,7 +29857,7 @@ paths: required: true schema: type: string - - &200 + - &201 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) @@ -29475,12 +29951,12 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - *63 - - *199 - *200 + - *201 - *19 - *17 - *48 - - &209 + - &210 name: sort description: The property to sort the results by. in: query @@ -29559,14 +30035,14 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - *63 - - *199 - *200 + - *201 responses: '200': description: Response content: application/json: - schema: &201 + schema: &202 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -29582,7 +30058,7 @@ paths: type: integer format: int64 examples: - default: &202 + default: &203 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -29603,23 +30079,23 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - *63 - - &205 + - &206 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *199 - *200 + - *201 responses: '200': description: Response content: application/json: - schema: *201 + schema: *202 examples: - default: *202 + default: *203 x-github: enabledForGitHubApps: true category: orgs @@ -29638,18 +30114,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *63 - - *199 - *200 - - *203 + - *201 - *204 + - *205 responses: '200': description: Response content: application/json: - schema: *201 + schema: *202 examples: - default: *202 + default: *203 x-github: enabledForGitHubApps: true category: orgs @@ -29667,9 +30143,9 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - *63 - - *199 - *200 - - &206 + - *201 + - &207 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -29682,7 +30158,7 @@ paths: description: Response content: application/json: - schema: &207 + schema: &208 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -29698,7 +30174,7 @@ paths: type: integer format: int64 examples: - default: &208 + default: &209 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -29735,18 +30211,18 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - *63 - - *205 - - *199 - - *200 - *206 + - *200 + - *201 + - *207 responses: '200': description: Response content: application/json: - schema: *207 + schema: *208 examples: - default: *208 + default: *209 x-github: enabledForGitHubApps: true category: orgs @@ -29764,19 +30240,19 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - *63 - - *203 - *204 - - *199 + - *205 - *200 - - *206 + - *201 + - *207 responses: '200': description: Response content: application/json: - schema: *207 + schema: *208 examples: - default: *208 + default: *209 x-github: enabledForGitHubApps: true category: orgs @@ -29794,13 +30270,13 @@ paths: url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - *63 - - *205 - - *199 + - *206 - *200 + - *201 - *19 - *17 - *48 - - *209 + - *210 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -29881,7 +30357,7 @@ paths: application/json: schema: *22 examples: - default: &518 + default: &516 value: id: 1 account: @@ -30047,12 +30523,12 @@ paths: application/json: schema: anyOf: - - &211 + - &212 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &210 + limit: &211 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -30077,7 +30553,7 @@ paths: properties: {} additionalProperties: false examples: - default: &212 + default: &213 value: limit: collaborators_only origin: organization @@ -30106,13 +30582,13 @@ paths: required: true content: application/json: - schema: &519 + schema: &517 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *210 + limit: *211 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -30136,9 +30612,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *212 + default: *213 '422': *15 x-github: githubCloudOnly: false @@ -30214,9 +30690,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 '404': *6 @@ -30293,7 +30769,7 @@ paths: description: Response content: application/json: - schema: *213 + schema: *214 examples: default: value: @@ -30348,7 +30824,7 @@ paths: url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - *63 - - &215 + - &216 name: invitation_id description: The unique identifier of the invitation. in: path @@ -30379,7 +30855,7 @@ paths: url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - *63 - - *215 + - *216 - *17 - *19 responses: @@ -30389,9 +30865,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: &233 + default: &234 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -30434,7 +30910,7 @@ paths: application/json: schema: type: array - items: *216 + items: *217 examples: default: value: @@ -30519,9 +30995,9 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: - default: &217 + default: &218 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -30554,7 +31030,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *63 - - &218 + - &219 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -30607,9 +31083,9 @@ paths: description: Response content: application/json: - schema: *216 + schema: *217 examples: - default: *217 + default: *218 '404': *6 '422': *7 x-github: @@ -30634,7 +31110,7 @@ paths: url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *63 - - *218 + - *219 responses: '204': description: Response @@ -30697,7 +31173,7 @@ paths: - closed - all default: open - - *219 + - *220 - name: type description: Can be the name of an issue type. in: query @@ -30728,7 +31204,7 @@ paths: type: array items: *82 examples: - default: *220 + default: *221 headers: Link: *54 '404': *6 @@ -30887,9 +31363,9 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: - default: *222 + default: *223 '304': *37 '500': *103 '401': *25 @@ -30916,7 +31392,7 @@ paths: parameters: - *63 - *59 - - &223 + - &224 name: codespace_name in: path required: true @@ -30951,15 +31427,15 @@ paths: parameters: - *63 - *59 - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: &446 + default: &444 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -31139,7 +31615,7 @@ paths: description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *224 + schema: *225 examples: default: value: @@ -31215,7 +31691,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &226 title: Org Membership description: Org Membership type: object @@ -31282,7 +31758,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &226 + response-if-user-has-an-active-admin-membership-with-organization: &227 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -31379,9 +31855,9 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: - response-if-user-already-had-membership-with-organization: *226 + response-if-user-already-had-membership-with-organization: *227 '422': *15 '403': *29 x-github: @@ -31452,7 +31928,7 @@ paths: application/json: schema: type: array - items: &227 + items: &228 title: Migration description: A migration. type: object @@ -31781,7 +32257,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -31960,7 +32436,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - *63 - - &228 + - &229 name: migration_id description: The unique identifier of the migration. in: path @@ -31987,7 +32463,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -32157,7 +32633,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - *63 - - *228 + - *229 responses: '302': description: Response @@ -32179,7 +32655,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *63 - - *228 + - *229 responses: '204': description: Response @@ -32203,8 +32679,8 @@ paths: url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - *63 - - *228 - - &677 + - *229 + - &676 name: repo_name description: repo_name parameter in: path @@ -32232,7 +32708,7 @@ paths: url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *63 - - *228 + - *229 - *17 - *19 responses: @@ -32242,9 +32718,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: &240 + default: &241 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32397,7 +32873,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &230 + items: &231 title: Organization Role description: Organization roles type: object @@ -32572,7 +33048,7 @@ paths: parameters: - *63 - *64 - - &229 + - &230 name: role_id description: The unique identifier of the role. in: path @@ -32609,7 +33085,7 @@ paths: parameters: - *63 - *64 - - *229 + - *230 responses: '204': description: Response @@ -32662,7 +33138,7 @@ paths: parameters: - *63 - *59 - - *229 + - *230 responses: '204': description: Response @@ -32694,7 +33170,7 @@ paths: parameters: - *63 - *59 - - *229 + - *230 responses: '204': description: Response @@ -32723,13 +33199,13 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - *63 - - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *230 + schema: *231 examples: default: value: @@ -32780,7 +33256,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - *63 - - *229 + - *230 - *17 - *19 responses: @@ -32858,8 +33334,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 nullable: true type: description: The ownership type of the team @@ -32891,7 +33367,7 @@ paths: - type - parent examples: - default: *233 + default: *234 headers: Link: *54 '404': @@ -32921,7 +33397,7 @@ paths: url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - *63 - - *229 + - *230 - *17 - *19 responses: @@ -32954,8 +33430,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 name: nullable: true type: string @@ -33243,7 +33719,7 @@ paths: - nuget - container - *63 - - &678 + - &677 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -33279,12 +33755,12 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *235 + default: *236 '403': *29 '401': *25 - '400': &680 + '400': &679 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -33306,7 +33782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &236 + - &237 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 @@ -33324,7 +33800,7 @@ paths: - docker - nuget - container - - &237 + - &238 name: package_name description: The name of the package. in: path @@ -33337,7 +33813,7 @@ paths: description: Response content: application/json: - schema: *234 + schema: *235 examples: default: value: @@ -33389,8 +33865,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *236 - *237 + - *238 - *63 responses: '204': @@ -33423,8 +33899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - name: token description: package token @@ -33457,8 +33933,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: - - *236 - *237 + - *238 - *63 - *19 - *17 @@ -33479,7 +33955,7 @@ paths: application/json: schema: type: array - items: &238 + items: &239 title: Package Version description: A version of a software package type: object @@ -33604,10 +34080,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - &239 + - &240 name: package_version_id description: Unique identifier of the package version. in: path @@ -33619,7 +34095,7 @@ paths: description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -33655,10 +34131,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - *239 + - *240 responses: '204': description: Response @@ -33690,10 +34166,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *236 - *237 + - *238 - *63 - - *239 + - *240 responses: '204': description: Response @@ -33723,7 +34199,7 @@ paths: - *63 - *17 - *19 - - &241 + - &242 name: sort description: The property by which to sort the results. in: query @@ -33734,7 +34210,7 @@ paths: - created_at default: created_at - *48 - - &242 + - &243 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -33745,7 +34221,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &243 + - &244 name: repository description: The name of the repository to use to filter the results. in: query @@ -33753,7 +34229,7 @@ paths: schema: type: string example: Hello-World - - &244 + - &245 name: permission description: The permission to use to filter the results. in: query @@ -33761,7 +34237,7 @@ paths: schema: type: string example: issues_read - - &245 + - &246 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) @@ -33771,7 +34247,7 @@ paths: schema: type: string format: date-time - - &246 + - &247 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) @@ -33781,7 +34257,7 @@ paths: schema: type: string format: date-time - - &247 + - &248 name: token_id description: The ID of the token in: query @@ -34051,7 +34527,7 @@ paths: '422': *15 '404': *6 '403': *29 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34092,9 +34568,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -34120,14 +34596,14 @@ paths: - *63 - *17 - *19 - - *241 - - *48 - *242 + - *48 - *243 - *244 - *245 - *246 - *247 + - *248 responses: '500': *103 '422': *15 @@ -34366,7 +34842,7 @@ paths: responses: '500': *103 '404': *6 - '204': *172 + '204': *173 '403': *29 '422': *15 x-github: @@ -34407,9 +34883,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -34451,7 +34927,7 @@ paths: type: integer configurations: type: array - items: &248 + items: &249 title: Organization private registry description: Private registry configuration for an organization type: object @@ -34741,7 +35217,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &249 + org-private-registry-with-selected-visibility: &250 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -34831,15 +35307,15 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *248 + schema: *249 examples: - default: *249 + default: *250 '404': *6 x-github: githubCloudOnly: false @@ -34861,7 +35337,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 requestBody: required: true content: @@ -34966,7 +35442,7 @@ paths: url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *63 - - *150 + - *151 responses: '204': description: Response @@ -34977,266 +35453,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: - - *63 - - 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: &250 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week - in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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: *54 - '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: - - *63 - 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: *250 - 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': *25 - '403': *29 - '404': *6 - '410': &330 - 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 @@ -35336,7 +35552,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &761 + properties: &760 id: type: number description: The unique identifier of the status update. @@ -35384,7 +35600,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &762 + required: &761 - id - node_id - created_at @@ -35708,7 +35924,7 @@ paths: - updated_at - project_url examples: - default: &697 + default: &696 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -35812,7 +36028,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - *253 - - &698 + - &697 name: field_id description: The unique identifier of the field. in: path @@ -35827,7 +36043,7 @@ paths: application/json: schema: *254 examples: - default: &699 + default: &698 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -36702,7 +36918,7 @@ paths: description: Response content: application/json: - schema: &700 + schema: &699 title: Projects v2 Item description: An item belonging to a project type: object @@ -36716,7 +36932,7 @@ paths: content: oneOf: - *82 - - &461 + - &459 title: Pull Request Simple description: Pull Request Simple type: object @@ -36868,7 +37084,7 @@ paths: nullable: true requested_teams: type: array - items: *178 + items: *179 nullable: true head: type: object @@ -36945,7 +37161,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: &566 + auto_merge: &565 title: Auto merge description: The status of auto merging a pull request. type: object @@ -37663,7 +37879,7 @@ paths: - *63 - *265 responses: - '204': *172 + '204': *173 '403': *29 '404': *6 x-github: @@ -37981,9 +38197,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -38185,7 +38401,7 @@ paths: description: Response content: application/json: - schema: &332 + schema: &330 title: Full Repository description: Full Repository type: object @@ -38578,7 +38794,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &466 + properties: &464 url: type: string format: uri @@ -38594,7 +38810,7 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &467 + required: &465 - url - key - name @@ -38683,7 +38899,7 @@ paths: - network_count - subscribers_count examples: - default: &334 + default: &332 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -39204,7 +39420,7 @@ paths: - *63 - *17 - *19 - - &589 + - &588 name: targets description: | A comma-separated list of rule targets to filter by. @@ -39485,7 +39701,7 @@ paths: - repository_property rules: type: array - items: &590 + items: &589 title: Repository Rule type: object description: A repository rule. @@ -39547,7 +39763,7 @@ paths: type: string enum: - required_linear_history - - &587 + - &586 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -40171,7 +40387,7 @@ paths: - tool required: - code_scanning_tools - - &588 + - &587 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code @@ -40397,7 +40613,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - *63 - - &591 + - &590 name: ref description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit @@ -40412,7 +40628,7 @@ paths: in: query schema: type: string - - &592 + - &591 name: time_period description: |- The time period to filter by. @@ -40428,14 +40644,14 @@ paths: - week - month default: day - - &593 + - &592 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &594 + - &593 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -40455,7 +40671,7 @@ paths: description: Response content: application/json: - schema: &595 + schema: &594 title: Rule Suites description: Response type: array @@ -40510,7 +40726,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &596 + default: &595 value: - id: 21 actor_id: 12 @@ -40554,7 +40770,7 @@ paths: url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *63 - - &597 + - &596 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -40570,7 +40786,7 @@ paths: description: Response content: application/json: - schema: &598 + schema: &597 title: Rule Suite description: Response type: object @@ -40669,7 +40885,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &599 + default: &598 value: id: 21 actor_id: 12 @@ -40915,7 +41131,7 @@ paths: type: string format: date-time examples: - default: &601 + default: &600 value: - version_id: 3 actor: @@ -40968,7 +41184,7 @@ paths: description: Response content: application/json: - schema: &602 + schema: &601 allOf: - *298 - type: object @@ -41040,7 +41256,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *63 - - &603 + - &602 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -41051,7 +41267,7 @@ paths: enum: - open - resolved - - &604 + - &603 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -41061,7 +41277,7 @@ paths: required: false schema: type: string - - &605 + - &604 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -41070,7 +41286,7 @@ paths: required: false schema: type: string - - &606 + - &605 name: sort description: The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. @@ -41085,7 +41301,7 @@ paths: - *48 - *19 - *17 - - &607 + - &606 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To @@ -41095,7 +41311,7 @@ paths: required: false schema: type: string - - &608 + - &607 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To @@ -41105,7 +41321,7 @@ paths: required: false schema: type: string - - &609 + - &608 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -41114,7 +41330,7 @@ paths: required: false schema: type: string - - &610 + - &609 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -41123,7 +41339,7 @@ paths: schema: type: boolean default: false - - &611 + - &610 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -41132,7 +41348,7 @@ paths: schema: type: boolean default: false - - &612 + - &611 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -41151,8 +41367,8 @@ paths: items: type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -41160,21 +41376,21 @@ paths: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &613 + state: &612 description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. type: string enum: - open - resolved - resolution: &614 + resolution: &613 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -41281,8 +41497,8 @@ paths: pull request. ' - oneOf: &615 - - &617 + oneOf: &614 + - &616 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -41334,7 +41550,7 @@ paths: - blob_url - commit_sha - commit_url - - &618 + - &617 description: Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. @@ -41389,7 +41605,7 @@ paths: - page_url - commit_sha - commit_url - - &619 + - &618 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -41403,7 +41619,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &620 + - &619 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -41417,7 +41633,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &621 + - &620 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -41431,7 +41647,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &622 + - &621 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -41445,7 +41661,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &623 + - &622 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -41459,7 +41675,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &624 + - &623 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -41473,7 +41689,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &625 + - &624 description: Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. @@ -41487,7 +41703,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &626 + - &625 description: Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. @@ -41501,7 +41717,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &627 + - &626 description: Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. @@ -41515,7 +41731,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &628 + - &627 description: Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. @@ -41529,7 +41745,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &629 + - &628 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -42027,7 +42243,7 @@ paths: application/json: schema: type: array - items: &633 + items: &632 description: A repository security advisory. type: object properties: @@ -42281,7 +42497,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *178 + items: *179 private_fork: readOnly: true nullable: true @@ -42318,7 +42534,7 @@ paths: - private_fork additionalProperties: false examples: - default: &634 + default: &633 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -42707,7 +42923,7 @@ paths: type: array items: *302 examples: - default: *233 + default: *234 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42792,7 +43008,7 @@ paths: description: Response content: application/json: - schema: &701 + schema: &700 type: object properties: total_minutes_used: @@ -42862,7 +43078,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &702 + default: &701 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -42898,7 +43114,7 @@ paths: description: Response content: application/json: - schema: &703 + schema: &702 type: object properties: total_gigabytes_bandwidth_used: @@ -42916,7 +43132,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &704 + default: &703 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -42948,7 +43164,7 @@ paths: description: Response content: application/json: - schema: &706 + schema: &705 type: object properties: days_left_in_billing_cycle: @@ -42966,7 +43182,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &707 + default: &706 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -43114,9 +43330,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *154 + default: *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43185,7 +43401,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -43208,7 +43424,7 @@ paths: url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *63 - - *131 + - *132 responses: '204': description: Response @@ -43671,9 +43887,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 headers: Link: *54 '403': *29 @@ -43830,8 +44046,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *231 - required: *232 + properties: *232 + required: *233 nullable: true members_count: type: integer @@ -44435,7 +44651,7 @@ paths: - updated_at - url examples: - default: &651 + default: &650 value: - author: login: octocat @@ -44683,7 +44899,7 @@ paths: application/json: schema: *311 examples: - default: &652 + default: &651 value: author: login: octocat @@ -44866,7 +45082,7 @@ paths: - updated_at - url examples: - default: &653 + default: &652 value: - author: login: octocat @@ -45092,7 +45308,7 @@ paths: application/json: schema: *314 examples: - default: &654 + default: &653 value: author: login: octocat @@ -45595,9 +45811,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 x-github: @@ -45708,7 +45924,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &655 + response-if-user-is-a-team-maintainer: &654 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -45773,7 +45989,7 @@ paths: application/json: schema: *321 examples: - response-if-users-membership-with-team-is-now-pending: &656 + response-if-users-membership-with-team-is-now-pending: &655 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -45914,7 +46130,7 @@ paths: - updated_at - permissions examples: - default: &657 + default: &656 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -45993,7 +46209,7 @@ paths: application/json: schema: *322 examples: - default: &658 + default: &657 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -46163,9 +46379,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -46203,7 +46419,7 @@ paths: description: Alternative response with repository permissions content: application/json: - schema: &659 + schema: &658 title: Team Repository description: A team's access to a repository. type: object @@ -46858,9 +47074,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - response-if-child-teams-exist: &660 + response-if-child-teams-exist: &659 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -47206,208 +47422,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: - - *323 - responses: - '200': - description: Response - content: - application/json: - schema: *250 - examples: - default: &329 - 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': *37 - '403': *29 - '401': *25 - 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: - - *323 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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: *250 - examples: - default: *329 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *330 - '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: - - *323 - responses: - '204': - description: Delete Success - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *330 - '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 @@ -47665,7 +47679,7 @@ paths: resources: type: object properties: - core: &331 + core: &329 title: Rate Limit type: object properties: @@ -47682,21 +47696,21 @@ paths: - remaining - reset - used - graphql: *331 - search: *331 - code_search: *331 - source_import: *331 - integration_manifest: *331 - code_scanning_upload: *331 - actions_runner_registration: *331 - scim: *331 - dependency_snapshots: *331 - dependency_sbom: *331 - code_scanning_autofix: *331 + graphql: *329 + search: *329 + code_search: *329 + source_import: *329 + integration_manifest: *329 + code_scanning_upload: *329 + actions_runner_registration: *329 + scim: *329 + dependency_snapshots: *329 + dependency_sbom: *329 + code_scanning_autofix: *329 required: - core - search - rate: *331 + rate: *329 required: - rate - resources @@ -47808,7 +47822,7 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: default-response: summary: Default response @@ -48309,7 +48323,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *333 + '301': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48575,10 +48589,10 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 - '307': &335 + default: *332 + '307': &333 description: Temporary Redirect content: application/json: @@ -48630,7 +48644,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *335 + '307': *333 '404': *6 '409': *47 x-github: @@ -48658,7 +48672,7 @@ paths: - *325 - *17 - *19 - - &366 + - &364 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -48681,7 +48695,7 @@ paths: type: integer artifacts: type: array - items: &336 + items: &334 title: Artifact description: An artifact type: object @@ -48759,7 +48773,7 @@ paths: - expires_at - updated_at examples: - default: &367 + default: &365 value: total_count: 2 artifacts: @@ -48822,7 +48836,7 @@ paths: parameters: - *324 - *325 - - &337 + - &335 name: artifact_id description: The unique identifier of the artifact. in: path @@ -48834,7 +48848,7 @@ paths: description: Response content: application/json: - schema: *336 + schema: *334 examples: default: value: @@ -48874,7 +48888,7 @@ paths: parameters: - *324 - *325 - - *337 + - *335 responses: '204': description: Response @@ -48900,7 +48914,7 @@ paths: parameters: - *324 - *325 - - *337 + - *335 - name: archive_format in: path required: true @@ -48914,7 +48928,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': *330 + '410': &520 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48944,7 +48962,7 @@ paths: description: Response content: application/json: - schema: *338 + schema: *336 examples: default: value: @@ -48974,7 +48992,7 @@ paths: - *325 - *17 - *19 - - &339 + - &337 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 @@ -49008,7 +49026,7 @@ paths: description: Response content: application/json: - schema: &340 + schema: &338 title: Repository actions caches description: Repository actions caches type: object @@ -49050,7 +49068,7 @@ paths: - total_count - actions_caches examples: - default: &341 + default: &339 value: total_count: 1 actions_caches: @@ -49090,15 +49108,15 @@ paths: required: true schema: type: string - - *339 + - *337 responses: '200': description: Response content: application/json: - schema: *340 + schema: *338 examples: - default: *341 + default: *339 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49152,7 +49170,7 @@ paths: parameters: - *324 - *325 - - &342 + - &340 name: job_id description: The unique identifier of the job. in: path @@ -49164,7 +49182,7 @@ paths: description: Response content: application/json: - schema: &370 + schema: &368 title: Job description: Information of a job execution in a workflow run type: object @@ -49473,7 +49491,7 @@ paths: parameters: - *324 - *325 - - *342 + - *340 responses: '302': description: Response @@ -49503,7 +49521,7 @@ paths: parameters: - *324 - *325 - - *342 + - *340 requestBody: required: false content: @@ -49524,7 +49542,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -49634,7 +49652,7 @@ paths: description: Empty response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -49682,7 +49700,7 @@ paths: type: integer secrets: type: array - items: &372 + items: &370 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -49702,7 +49720,7 @@ paths: - created_at - updated_at examples: - default: &373 + default: &371 value: total_count: 2 secrets: @@ -49737,7 +49755,7 @@ paths: parameters: - *324 - *325 - - *343 + - *341 - *19 responses: '200': @@ -49754,7 +49772,7 @@ paths: type: integer variables: type: array - items: &376 + items: &374 title: Actions Variable type: object properties: @@ -49784,7 +49802,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &375 value: total_count: 2 variables: @@ -49827,12 +49845,12 @@ paths: schema: type: object properties: - enabled: &345 + enabled: &343 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *127 - selected_actions_url: *344 - sha_pinning_required: *128 + allowed_actions: *128 + selected_actions_url: *342 + sha_pinning_required: *129 required: - enabled examples: @@ -49872,9 +49890,9 @@ paths: schema: type: object properties: - enabled: *345 - allowed_actions: *127 - sha_pinning_required: *128 + enabled: *343 + allowed_actions: *128 + sha_pinning_required: *129 required: - enabled examples: @@ -49911,7 +49929,7 @@ paths: description: Response content: application/json: - schema: &346 + schema: &344 type: object properties: access_level: @@ -49928,7 +49946,7 @@ paths: required: - access_level examples: - default: &347 + default: &345 value: access_level: organization x-github: @@ -49958,9 +49976,9 @@ paths: required: true content: application/json: - schema: *346 + schema: *344 examples: - default: *347 + default: *345 responses: '204': description: Response @@ -49991,7 +50009,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *346 examples: default: value: @@ -50026,7 +50044,7 @@ paths: required: true content: application/json: - schema: *349 + schema: *347 examples: default: summary: Set retention days @@ -50057,9 +50075,9 @@ paths: description: Response content: application/json: - schema: *129 + schema: *130 examples: - default: *350 + default: *348 '404': *6 x-github: enabledForGitHubApps: true @@ -50089,7 +50107,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *130 examples: default: summary: Set approval policy to first time contributors @@ -50120,9 +50138,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *349 examples: - default: *130 + default: *131 '403': *29 '404': *6 x-github: @@ -50148,9 +50166,9 @@ paths: required: true content: application/json: - schema: *352 + schema: *350 examples: - default: *130 + default: *131 responses: '204': description: Empty response for successful settings update @@ -50181,9 +50199,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *133 examples: - default: *133 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50211,9 +50229,9 @@ paths: required: false content: application/json: - schema: *132 + schema: *133 examples: - selected_actions: *133 + selected_actions: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50242,9 +50260,9 @@ paths: description: Response content: application/json: - schema: *353 + schema: *351 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50277,9 +50295,9 @@ paths: required: true content: application/json: - schema: *354 + schema: *352 examples: - default: *137 + default: *138 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50325,9 +50343,9 @@ paths: type: integer runners: type: array - items: *144 + items: *145 examples: - default: *145 + default: *146 headers: Link: *54 x-github: @@ -50360,9 +50378,9 @@ paths: application/json: schema: type: array - items: *355 + items: *353 examples: - default: *356 + default: *354 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50428,7 +50446,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *357 + '201': *355 '404': *6 '422': *7 '409': *47 @@ -50466,9 +50484,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: *358 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50503,9 +50521,9 @@ paths: description: Response content: application/json: - schema: *146 + schema: *147 examples: - default: *359 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50529,15 +50547,15 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: '200': description: Response content: application/json: - schema: *144 + schema: *145 examples: - default: *360 + default: *358 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50560,7 +50578,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: '204': description: Response @@ -50588,9 +50606,9 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: - '200': *148 + '200': *149 '404': *6 x-github: githubCloudOnly: false @@ -50614,7 +50632,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 requestBody: required: true content: @@ -50638,7 +50656,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50664,7 +50682,7 @@ paths: parameters: - *324 - *325 - - *143 + - *144 requestBody: required: true content: @@ -50689,7 +50707,7 @@ paths: - gpu - accelerated responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50715,9 +50733,9 @@ paths: parameters: - *324 - *325 - - *143 + - *144 responses: - '200': *361 + '200': *359 '404': *6 x-github: githubCloudOnly: false @@ -50746,10 +50764,10 @@ paths: parameters: - *324 - *325 - - *143 - - *362 + - *144 + - *360 responses: - '200': *148 + '200': *149 '404': *6 '422': *7 x-github: @@ -50777,7 +50795,7 @@ paths: parameters: - *324 - *325 - - &380 + - &378 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. @@ -50785,7 +50803,7 @@ paths: required: false schema: type: string - - &381 + - &379 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -50793,7 +50811,7 @@ paths: required: false schema: type: string - - &382 + - &380 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -50802,7 +50820,7 @@ paths: required: false schema: type: string - - &383 + - &381 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 @@ -50829,7 +50847,7 @@ paths: - pending - *17 - *19 - - &384 + - &382 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)." @@ -50838,7 +50856,7 @@ paths: schema: type: string format: date-time - - &363 + - &361 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -50847,13 +50865,13 @@ paths: schema: type: boolean default: false - - &385 + - &383 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &386 + - &384 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -50876,7 +50894,7 @@ paths: type: integer workflow_runs: type: array - items: &364 + items: &362 title: Workflow Run description: An invocation of a workflow type: object @@ -50971,7 +50989,7 @@ paths: that triggered the run. type: array nullable: true - items: &405 + items: &403 title: Pull Request Minimal type: object properties: @@ -51090,7 +51108,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &409 + properties: &407 id: type: string description: SHA for the commit @@ -51141,7 +51159,7 @@ paths: - name - email nullable: true - required: &410 + required: &408 - id - tree_id - message @@ -51149,8 +51167,8 @@ paths: - author - committer nullable: true - repository: *142 - head_repository: *142 + repository: *143 + head_repository: *143 head_repository_id: type: integer example: 5 @@ -51188,7 +51206,7 @@ paths: - workflow_url - pull_requests examples: - default: &387 + default: &385 value: total_count: 1 workflow_runs: @@ -51426,22 +51444,22 @@ paths: parameters: - *324 - *325 - - &365 + - &363 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *363 + - *361 responses: '200': description: Response content: application/json: - schema: *364 + schema: *362 examples: - default: &368 + default: &366 value: id: 30433642 name: Build @@ -51684,7 +51702,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '204': description: Response @@ -51709,7 +51727,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -51830,13 +51848,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -51865,10 +51883,10 @@ paths: parameters: - *324 - *325 - - *365 + - *363 - *17 - *19 - - *366 + - *364 responses: '200': description: Response @@ -51884,9 +51902,9 @@ paths: type: integer artifacts: type: array - items: *336 + items: *334 examples: - default: *367 + default: *365 headers: Link: *54 x-github: @@ -51912,23 +51930,23 @@ paths: parameters: - *324 - *325 - - *365 - - &369 + - *363 + - &367 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *363 + - *361 responses: '200': description: Response content: application/json: - schema: *364 + schema: *362 examples: - default: *368 + default: *366 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51953,8 +51971,8 @@ paths: parameters: - *324 - *325 - - *365 - - *369 + - *363 + - *367 - *17 - *19 responses: @@ -51972,9 +51990,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *368 examples: - default: &371 + default: &369 value: total_count: 1 jobs: @@ -52089,8 +52107,8 @@ paths: parameters: - *324 - *325 - - *365 - - *369 + - *363 + - *367 responses: '302': description: Response @@ -52120,13 +52138,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '202': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52155,7 +52173,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: true content: @@ -52224,13 +52242,13 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '202': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52259,7 +52277,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 - 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 @@ -52289,9 +52307,9 @@ paths: type: integer jobs: type: array - items: *370 + items: *368 examples: - default: *371 + default: *369 headers: Link: *54 x-github: @@ -52318,7 +52336,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '302': description: Response @@ -52347,7 +52365,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '204': description: Response @@ -52376,7 +52394,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -52436,7 +52454,7 @@ paths: items: type: object properties: - type: &488 + type: &486 type: string description: The type of reviewer. enum: @@ -52446,7 +52464,7 @@ paths: reviewer: anyOf: - *4 - - *178 + - *179 required: - environment - wait_timer @@ -52523,7 +52541,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: true content: @@ -52570,7 +52588,7 @@ paths: application/json: schema: type: array - items: &483 + items: &481 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -52676,7 +52694,7 @@ paths: - created_at - updated_at examples: - default: &484 + default: &482 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -52734,7 +52752,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: false content: @@ -52755,7 +52773,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52780,7 +52798,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 requestBody: required: false content: @@ -52801,7 +52819,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -52835,7 +52853,7 @@ paths: parameters: - *324 - *325 - - *365 + - *363 responses: '200': description: Response @@ -52991,9 +53009,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *370 examples: - default: *373 + default: *371 headers: Link: *54 x-github: @@ -53025,9 +53043,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *372 examples: - default: *375 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53051,15 +53069,15 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *372 + schema: *370 examples: - default: &501 + default: &499 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -53087,7 +53105,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -53118,7 +53136,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -53146,7 +53164,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -53173,7 +53191,7 @@ paths: parameters: - *324 - *325 - - *343 + - *341 - *19 responses: '200': @@ -53190,9 +53208,9 @@ paths: type: integer variables: type: array - items: *376 + items: *374 examples: - default: *377 + default: *375 headers: Link: *54 x-github: @@ -53243,7 +53261,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -53270,15 +53288,15 @@ paths: parameters: - *324 - *325 - - *153 + - *154 responses: '200': description: Response content: application/json: - schema: *376 + schema: *374 examples: - default: &502 + default: &500 value: name: USERNAME value: octocat @@ -53306,7 +53324,7 @@ paths: parameters: - *324 - *325 - - *153 + - *154 requestBody: required: true content: @@ -53350,7 +53368,7 @@ paths: parameters: - *324 - *325 - - *153 + - *154 responses: '204': description: Response @@ -53394,7 +53412,7 @@ paths: type: integer workflows: type: array - items: &378 + items: &376 title: Workflow description: A GitHub Actions workflow type: object @@ -53503,7 +53521,7 @@ paths: parameters: - *324 - *325 - - &379 + - &377 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -53518,7 +53536,7 @@ paths: description: Response content: application/json: - schema: *378 + schema: *376 examples: default: value: @@ -53553,7 +53571,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53580,7 +53598,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53633,7 +53651,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '204': description: Response @@ -53662,17 +53680,17 @@ paths: parameters: - *324 - *325 + - *377 + - *378 - *379 - *380 - *381 - - *382 - - *383 - *17 - *19 + - *382 + - *361 + - *383 - *384 - - *363 - - *385 - - *386 responses: '200': description: Response @@ -53688,9 +53706,9 @@ paths: type: integer workflow_runs: type: array - items: *364 + items: *362 examples: - default: *387 + default: *385 headers: Link: *54 x-github: @@ -53724,7 +53742,7 @@ paths: parameters: - *324 - *325 - - *379 + - *377 responses: '200': description: Response @@ -54196,7 +54214,7 @@ paths: initiator: type: string examples: - default: *388 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54225,7 +54243,7 @@ paths: application/json: schema: type: array - items: &389 + items: &387 title: Autolink reference description: An autolink reference. type: object @@ -54319,9 +54337,9 @@ paths: description: response content: application/json: - schema: *389 + schema: *387 examples: - default: &390 + default: &388 value: id: 1 key_prefix: TICKET- @@ -54354,7 +54372,7 @@ paths: parameters: - *324 - *325 - - &391 + - &389 name: autolink_id description: The unique identifier of the autolink. in: path @@ -54366,9 +54384,9 @@ paths: description: Response content: application/json: - schema: *389 + schema: *387 examples: - default: *390 + default: *388 '404': *6 x-github: githubCloudOnly: false @@ -54390,7 +54408,7 @@ paths: parameters: - *324 - *325 - - *391 + - *389 responses: '204': description: Response @@ -54545,7 +54563,7 @@ paths: - url protected: type: boolean - protection: &393 + protection: &391 title: Branch Protection description: Branch Protection type: object @@ -54587,7 +54605,7 @@ paths: required: - contexts - checks - enforce_admins: &396 + enforce_admins: &394 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -54602,7 +54620,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &398 + required_pull_request_reviews: &396 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -54623,7 +54641,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *178 + items: *179 apps: description: The list of apps with review dismissal access. @@ -54652,7 +54670,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *178 + items: *179 apps: description: The list of apps allowed to bypass pull request requirements. @@ -54678,7 +54696,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &395 + restrictions: &393 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -54741,7 +54759,7 @@ paths: type: string teams: type: array - items: *178 + items: *179 apps: type: array items: @@ -54957,7 +54975,7 @@ paths: parameters: - *324 - *325 - - &394 + - &392 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). @@ -54971,14 +54989,14 @@ paths: description: Response content: application/json: - schema: &404 + schema: &402 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &457 + commit: &455 title: Commit description: Commit type: object @@ -55012,7 +55030,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &392 + properties: &390 name: type: string example: '"Chris Wanstrath"' @@ -55027,7 +55045,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true message: type: string @@ -55048,7 +55066,7 @@ paths: required: - sha - url - verification: &508 + verification: &506 title: Verification type: object properties: @@ -55082,12 +55100,12 @@ paths: nullable: true oneOf: - *4 - - *151 + - *152 committer: nullable: true oneOf: - *4 - - *151 + - *152 parents: type: array items: @@ -55118,7 +55136,7 @@ paths: type: integer files: type: array - items: &470 + items: &468 title: Diff Entry description: Diff Entry type: object @@ -55202,7 +55220,7 @@ paths: - self protected: type: boolean - protection: *393 + protection: *391 protection_url: type: string format: uri @@ -55309,7 +55327,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *333 + '301': *331 '404': *6 x-github: githubCloudOnly: false @@ -55333,13 +55351,13 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *393 + schema: *391 examples: default: value: @@ -55535,7 +55553,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -55790,7 +55808,7 @@ paths: url: type: string format: uri - required_status_checks: &401 + required_status_checks: &399 title: Status Check Policy description: Status Check Policy type: object @@ -55866,7 +55884,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 apps: type: array items: *5 @@ -55884,7 +55902,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 apps: type: array items: *5 @@ -55942,7 +55960,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *395 + restrictions: *393 required_conversation_resolution: type: object properties: @@ -56056,7 +56074,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56083,15 +56101,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: &397 + default: &395 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -56115,15 +56133,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: *397 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56144,7 +56162,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56171,15 +56189,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *398 + schema: *396 examples: - default: &399 + default: &397 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -56277,7 +56295,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56375,9 +56393,9 @@ paths: description: Response content: application/json: - schema: *398 + schema: *396 examples: - default: *399 + default: *397 '422': *15 x-github: githubCloudOnly: false @@ -56400,7 +56418,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56429,15 +56447,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: &400 + default: &398 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -56462,15 +56480,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *396 + schema: *394 examples: - default: *400 + default: *398 '404': *6 x-github: githubCloudOnly: false @@ -56492,7 +56510,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56519,15 +56537,15 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *401 + schema: *399 examples: - default: &402 + default: &400 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -56555,7 +56573,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56607,9 +56625,9 @@ paths: description: Response content: application/json: - schema: *401 + schema: *399 examples: - default: *402 + default: *400 '404': *6 '422': *15 x-github: @@ -56633,7 +56651,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -56659,7 +56677,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -56695,7 +56713,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56764,7 +56782,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -56830,7 +56848,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: content: application/json: @@ -56898,13 +56916,13 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response content: application/json: - schema: *395 + schema: *393 examples: default: value: @@ -56997,7 +57015,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '204': description: Response @@ -57022,7 +57040,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57032,7 +57050,7 @@ paths: type: array items: *5 examples: - default: &403 + default: &401 value: - id: 1 slug: octoapp @@ -57091,7 +57109,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57125,7 +57143,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57148,7 +57166,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57182,7 +57200,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57205,7 +57223,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57239,7 +57257,7 @@ paths: type: array items: *5 examples: - default: *403 + default: *401 '422': *15 x-github: githubCloudOnly: false @@ -57263,7 +57281,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57271,9 +57289,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '404': *6 x-github: githubCloudOnly: false @@ -57295,7 +57313,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -57331,9 +57349,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57356,7 +57374,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: false content: @@ -57392,9 +57410,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57417,7 +57435,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: content: application/json: @@ -57452,9 +57470,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 '422': *15 x-github: githubCloudOnly: false @@ -57478,7 +57496,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 responses: '200': description: Response @@ -57514,7 +57532,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57574,7 +57592,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57634,7 +57652,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57696,7 +57714,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 requestBody: required: true content: @@ -57718,7 +57736,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *402 examples: default: value: @@ -58114,7 +58132,7 @@ paths: description: Response content: application/json: - schema: &406 + schema: &404 title: CheckRun description: A check performed on the code of a given code change type: object @@ -58233,8 +58251,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *405 - deployment: &719 + items: *403 + deployment: &718 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -58516,7 +58534,7 @@ paths: parameters: - *324 - *325 - - &407 + - &405 name: check_run_id description: The unique identifier of the check run. in: path @@ -58528,9 +58546,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *404 examples: - default: &408 + default: &406 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -58632,7 +58650,7 @@ paths: parameters: - *324 - *325 - - *407 + - *405 requestBody: required: true content: @@ -58872,9 +58890,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *404 examples: - default: *408 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58896,7 +58914,7 @@ paths: parameters: - *324 - *325 - - *407 + - *405 - *17 - *19 responses: @@ -58993,13 +59011,13 @@ paths: parameters: - *324 - *325 - - *407 + - *405 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -59060,7 +59078,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &411 + schema: &409 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -59124,7 +59142,7 @@ paths: nullable: true pull_requests: type: array - items: *405 + items: *403 nullable: true app: title: GitHub app @@ -59137,7 +59155,7 @@ paths: nullable: true properties: *67 required: *68 - repository: *142 + repository: *143 created_at: type: string format: date-time @@ -59146,12 +59164,12 @@ paths: type: string format: date-time nullable: true - head_commit: &745 + head_commit: &744 title: Simple Commit description: A commit. type: object - properties: *409 - required: *410 + properties: *407 + required: *408 latest_check_runs_count: type: integer check_runs_url: @@ -59179,7 +59197,7 @@ paths: - check_runs_url - pull_requests examples: - default: &412 + default: &410 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -59470,9 +59488,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59553,7 +59571,7 @@ paths: required: - app_id - setting - repository: *142 + repository: *143 examples: default: value: @@ -59803,7 +59821,7 @@ paths: parameters: - *324 - *325 - - &413 + - &411 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -59815,9 +59833,9 @@ paths: description: Response content: application/json: - schema: *411 + schema: *409 examples: - default: *412 + default: *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59842,15 +59860,15 @@ paths: parameters: - *324 - *325 - - *413 - - &463 + - *411 + - &461 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &464 + - &462 name: status description: Returns check runs with the specified `status`. in: query @@ -59889,9 +59907,9 @@ paths: type: integer check_runs: type: array - items: *406 + items: *404 examples: - default: &465 + default: &463 value: total_count: 1 check_runs: @@ -59995,13 +60013,13 @@ paths: parameters: - *324 - *325 - - *413 + - *411 responses: '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -60030,19 +60048,19 @@ paths: parameters: - *324 - *325 - - *414 - - *415 + - *412 + - *413 - *19 - *17 - - &432 + - &430 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: *416 - - &433 + schema: *414 + - &431 name: pr description: The number of the pull request for the results you want to list. in: query @@ -60067,13 +60085,13 @@ paths: be returned. in: query required: false - schema: *417 + schema: *415 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *418 + schema: *416 responses: '200': description: Response @@ -60084,14 +60102,14 @@ paths: items: type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: *419 - state: *167 - fixed_at: *163 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: *417 + state: *168 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -60099,12 +60117,12 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: *420 - dismissed_comment: *421 - rule: *422 - tool: *423 - most_recent_instance: *424 + dismissed_at: *165 + dismissed_reason: *418 + dismissed_comment: *419 + rule: *420 + tool: *421 + most_recent_instance: *422 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60230,7 +60248,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &425 + '403': &423 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -60259,7 +60277,7 @@ paths: parameters: - *324 - *325 - - &426 + - &424 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -60267,23 +60285,23 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *158 + schema: *159 responses: '200': description: Response content: application/json: - schema: &427 + schema: &425 type: object properties: - number: *158 - created_at: *159 - updated_at: *160 - url: *161 - html_url: *162 - instances_url: *419 - state: *167 - fixed_at: *163 + number: *159 + created_at: *160 + updated_at: *161 + url: *162 + html_url: *163 + instances_url: *417 + state: *168 + fixed_at: *164 dismissed_by: title: Simple User description: A GitHub user. @@ -60291,9 +60309,9 @@ paths: properties: *20 required: *21 nullable: true - dismissed_at: *164 - dismissed_reason: *420 - dismissed_comment: *421 + dismissed_at: *165 + dismissed_reason: *418 + dismissed_comment: *419 rule: type: object properties: @@ -60347,8 +60365,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *423 - most_recent_instance: *424 + tool: *421 + most_recent_instance: *422 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -60447,7 +60465,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60469,7 +60487,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: true content: @@ -60484,8 +60502,8 @@ paths: enum: - open - dismissed - dismissed_reason: *420 - dismissed_comment: *421 + dismissed_reason: *418 + dismissed_comment: *419 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -60504,7 +60522,7 @@ paths: description: Response content: application/json: - schema: *427 + schema: *425 examples: default: value: @@ -60580,7 +60598,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &431 + '403': &429 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -60609,13 +60627,13 @@ paths: parameters: - *324 - *325 - - *426 + - *424 responses: '200': description: Response content: application/json: - schema: &428 + schema: &426 type: object properties: status: @@ -60641,13 +60659,13 @@ paths: - description - started_at examples: - default: &429 + default: &427 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &430 + '400': &428 description: Bad Request content: application/json: @@ -60658,7 +60676,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': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60685,27 +60703,27 @@ paths: parameters: - *324 - *325 - - *426 + - *424 responses: '200': description: OK content: application/json: - schema: *428 + schema: *426 examples: - default: *429 + default: *427 '202': description: Accepted content: application/json: - schema: *428 + schema: *426 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *430 + '400': *428 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -60739,7 +60757,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: false content: @@ -60784,8 +60802,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *430 - '403': *431 + '400': *428 + '403': *429 '404': *6 '422': description: Unprocessable Entity @@ -60811,11 +60829,11 @@ paths: parameters: - *324 - *325 - - *426 + - *424 - *19 - *17 - - *432 - - *433 + - *430 + - *431 responses: '200': description: Response @@ -60823,7 +60841,7 @@ paths: application/json: schema: type: array - items: *424 + items: *422 examples: default: value: @@ -60862,7 +60880,7 @@ paths: end_column: 50 classifications: - source - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -60898,23 +60916,23 @@ paths: parameters: - *324 - *325 - - *414 - - *415 + - *412 + - *413 - *19 - *17 - - *433 + - *431 - 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: *416 + schema: *414 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &436 + schema: &434 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -60935,23 +60953,23 @@ paths: application/json: schema: type: array - items: &437 + items: &435 type: object properties: - ref: *416 - commit_sha: &445 + ref: *414 + commit_sha: &443 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: *434 + analysis_key: *432 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *435 + category: *433 error: type: string example: error reading field xyz @@ -60975,8 +60993,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *436 - tool: *423 + sarif_id: *434 + tool: *421 deletable: type: boolean warning: @@ -61037,7 +61055,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61087,7 +61105,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *435 examples: response: summary: application/json response @@ -61141,7 +61159,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *425 + '403': *423 '404': *6 '422': description: Response if analysis could not be processed @@ -61282,7 +61300,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': *431 + '403': *429 '404': *6 '503': *104 x-github: @@ -61313,7 +61331,7 @@ paths: application/json: schema: type: array - items: &438 + items: &436 title: CodeQL Database description: A CodeQL database. type: object @@ -61424,7 +61442,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': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61466,7 +61484,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *436 examples: default: value: @@ -61498,9 +61516,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': &472 + '302': &470 description: Found - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -61533,7 +61551,7 @@ paths: responses: '204': description: Response - '403': *431 + '403': *429 '404': *6 '503': *104 x-github: @@ -61571,7 +61589,7 @@ paths: type: object additionalProperties: false properties: - language: &439 + language: &437 type: string description: The language targeted by the CodeQL query enum: @@ -61650,7 +61668,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &443 + schema: &441 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -61660,7 +61678,7 @@ paths: description: The ID of the variant analysis. controller_repo: *53 actor: *4 - query_language: *439 + query_language: *437 query_pack_url: type: string description: The download url for the query pack. @@ -61707,7 +61725,7 @@ paths: items: type: object properties: - repository: &440 + repository: &438 title: Repository Identifier description: Repository Identifier type: object @@ -61743,7 +61761,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &444 + analysis_status: &442 type: string description: The new status of the CodeQL variant analysis repository task. @@ -61775,7 +61793,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &441 + access_mismatch_repos: &439 type: object properties: repository_count: @@ -61789,7 +61807,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: *440 + items: *438 required: - repository_count - repositories @@ -61811,8 +61829,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *441 - over_limit_repos: *441 + no_codeql_db_repos: *439 + over_limit_repos: *439 required: - access_mismatch_repos - not_found_repos @@ -61828,7 +61846,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &442 + value: &440 summary: Default response value: id: 1 @@ -61980,10 +61998,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *442 + value: *440 repository_lists: summary: Response for a successful variant analysis submission - value: *442 + value: *440 '404': *6 '422': description: Unable to process variant analysis submission @@ -62024,9 +62042,9 @@ paths: description: Response content: application/json: - schema: *443 + schema: *441 examples: - default: *442 + default: *440 '404': *6 '503': *104 x-github: @@ -62084,7 +62102,7 @@ paths: type: object properties: repository: *53 - analysis_status: *444 + analysis_status: *442 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -62295,7 +62313,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *425 + '403': *423 '404': *6 '503': *104 x-github: @@ -62384,7 +62402,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -62409,7 +62427,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *431 + '403': *429 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -62489,7 +62507,7 @@ paths: schema: type: object properties: - commit_sha: *445 + commit_sha: *443 ref: type: string description: |- @@ -62547,7 +62565,7 @@ paths: schema: type: object properties: - id: *436 + id: *434 url: type: string description: The REST API URL for checking the status of the upload. @@ -62561,7 +62579,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': *431 + '403': *429 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -62631,7 +62649,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': *425 + '403': *423 '404': description: Not Found if the sarif id does not match any upload '503': *104 @@ -62713,7 +62731,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': *172 + '204': *173 '304': *37 '403': *29 '404': *6 @@ -62876,7 +62894,7 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: default: value: @@ -63238,17 +63256,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '400': *14 '401': *25 '403': *29 @@ -63378,14 +63396,14 @@ paths: type: integer machines: type: array - items: &667 + items: &666 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *447 - required: *448 + properties: *445 + required: *446 examples: - default: &668 + default: &667 value: total_count: 2 machines: @@ -63596,7 +63614,7 @@ paths: type: integer secrets: type: array - items: &452 + items: &450 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -63616,7 +63634,7 @@ paths: - created_at - updated_at examples: - default: *449 + default: *447 headers: Link: *54 x-github: @@ -63646,9 +63664,9 @@ paths: description: Response content: application/json: - schema: *450 + schema: *448 examples: - default: *451 + default: *449 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -63670,15 +63688,15 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *452 + schema: *450 examples: - default: *453 + default: *451 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63700,7 +63718,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -63728,7 +63746,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -63754,7 +63772,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -63825,7 +63843,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &454 + properties: &452 login: type: string example: octocat @@ -63918,7 +63936,7 @@ paths: user_view_type: type: string example: public - required: &455 + required: &453 - avatar_url - events_url - followers_url @@ -64068,7 +64086,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &521 + schema: &519 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -64079,7 +64097,7 @@ paths: example: 42 type: integer format: int64 - repository: *142 + repository: *143 invitee: title: Simple User description: A GitHub user. @@ -64257,7 +64275,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *111 + schema: *112 '403': *29 x-github: triggersNotification: true @@ -64352,8 +64370,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *454 - required: *455 + properties: *452 + required: *453 nullable: true required: - permission @@ -64419,7 +64437,7 @@ paths: application/json: schema: type: array - items: &456 + items: &454 title: Commit Comment description: Commit Comment type: object @@ -64477,7 +64495,7 @@ paths: - created_at - updated_at examples: - default: &459 + default: &457 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64544,9 +64562,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: - default: &460 + default: &458 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -64627,7 +64645,7 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: default: value: @@ -64926,9 +64944,9 @@ paths: application/json: schema: type: array - items: *457 + items: *455 examples: - default: &573 + default: &572 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65024,7 +65042,7 @@ paths: parameters: - *324 - *325 - - &458 + - &456 name: commit_sha description: The SHA of the commit. in: path @@ -65098,7 +65116,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 - *17 - *19 responses: @@ -65108,9 +65126,9 @@ paths: application/json: schema: type: array - items: *456 + items: *454 examples: - default: *459 + default: *457 headers: Link: *54 x-github: @@ -65140,7 +65158,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 requestBody: required: true content: @@ -65175,9 +65193,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *454 examples: - default: *460 + default: *458 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -65207,7 +65225,7 @@ paths: parameters: - *324 - *325 - - *458 + - *456 - *17 - *19 responses: @@ -65217,9 +65235,9 @@ paths: application/json: schema: type: array - items: *461 + items: *459 examples: - default: &565 + default: &564 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -65760,7 +65778,7 @@ paths: - *325 - *19 - *17 - - &462 + - &460 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)" @@ -65775,9 +65793,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *455 examples: - default: &550 + default: &549 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -65892,9 +65910,9 @@ paths: parameters: - *324 - *325 + - *460 + - *461 - *462 - - *463 - - *464 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -65928,9 +65946,9 @@ paths: type: integer check_runs: type: array - items: *406 + items: *404 examples: - default: *465 + default: *463 headers: Link: *54 x-github: @@ -65957,7 +65975,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -65965,7 +65983,7 @@ paths: schema: type: integer example: 1 - - *463 + - *461 - *17 - *19 responses: @@ -65983,7 +66001,7 @@ paths: type: integer check_suites: type: array - items: *411 + items: *409 examples: default: value: @@ -66185,7 +66203,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - *17 - *19 responses: @@ -66252,7 +66270,7 @@ paths: type: string total_count: type: integer - repository: *142 + repository: *143 commit_url: type: string format: uri @@ -66385,7 +66403,7 @@ paths: parameters: - *324 - *325 - - *462 + - *460 - *17 - *19 responses: @@ -66395,7 +66413,7 @@ paths: application/json: schema: type: array - items: &638 + items: &637 title: Status description: The status of a commit. type: object @@ -66476,7 +66494,7 @@ paths: site_admin: false headers: Link: *54 - '301': *333 + '301': *331 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66534,20 +66552,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *466 - required: *467 + properties: *464 + required: *465 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &468 + properties: &466 url: type: string format: uri html_url: type: string format: uri - required: &469 + required: &467 - url - html_url nullable: true @@ -66561,26 +66579,26 @@ paths: contributing: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true readme: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true issue_template: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true pull_request_template: title: Community Health File type: object - properties: *468 - required: *469 + properties: *466 + required: *467 nullable: true required: - code_of_conduct @@ -66751,8 +66769,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *457 - merge_base_commit: *457 + base_commit: *455 + merge_base_commit: *455 status: type: string enum: @@ -66772,10 +66790,10 @@ paths: example: 6 commits: type: array - items: *457 + items: *455 files: type: array - items: *470 + items: *468 required: - url - html_url @@ -67205,7 +67223,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &471 + response-if-content-is-a-file: &469 summary: Response if content is a file value: type: file @@ -67337,7 +67355,7 @@ paths: - size - type - url - - &578 + - &577 title: Content File description: Content File type: object @@ -67538,7 +67556,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *471 + response-if-content-is-a-file: *469 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -67607,7 +67625,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *472 + '302': *470 '304': *37 x-github: githubCloudOnly: false @@ -67724,7 +67742,7 @@ paths: description: Response content: application/json: - schema: &473 + schema: &471 title: File Commit description: File Commit type: object @@ -67876,7 +67894,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: example-for-creating-a-file: value: @@ -67930,7 +67948,7 @@ paths: schema: oneOf: - *3 - - &503 + - &501 description: Repository rule violation was detected type: object properties: @@ -67951,7 +67969,7 @@ paths: items: type: object properties: - placeholder_id: &630 + placeholder_id: &629 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -68045,7 +68063,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *471 examples: default: value: @@ -68226,20 +68244,20 @@ paths: parameters: - *324 - *325 - - *179 - *180 - *181 - *182 + - *183 - 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 - - *183 - - *474 - *184 + - *472 - *185 + - *186 - *48 - name: per_page description: The number of results per page (max 100). For more information, @@ -68258,11 +68276,11 @@ paths: application/json: schema: type: array - items: &477 + items: &475 type: object description: A Dependabot alert. properties: - number: *158 + number: *159 state: type: string description: The state of the Dependabot alert. @@ -68304,13 +68322,13 @@ paths: - unknown - direct - transitive - security_advisory: *475 + security_advisory: *473 security_vulnerability: *52 - url: *161 - html_url: *162 - created_at: *159 - updated_at: *160 - dismissed_at: *164 + url: *162 + html_url: *163 + created_at: *160 + updated_at: *161 + dismissed_at: *165 dismissed_by: title: Simple User description: A GitHub user. @@ -68334,8 +68352,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *163 - auto_dismissed_at: *476 + fixed_at: *164 + auto_dismissed_at: *474 required: - number - state @@ -68567,7 +68585,7 @@ paths: parameters: - *324 - *325 - - &478 + - &476 name: alert_number in: path description: |- @@ -68576,13 +68594,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *158 + schema: *159 responses: '200': description: Response content: application/json: - schema: *477 + schema: *475 examples: default: value: @@ -68697,7 +68715,7 @@ paths: parameters: - *324 - *325 - - *478 + - *476 requestBody: required: true content: @@ -68742,7 +68760,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *475 examples: default: value: @@ -68890,7 +68908,7 @@ paths: type: integer secrets: type: array - items: &481 + items: &479 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -68950,9 +68968,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *477 examples: - default: *480 + default: *478 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68974,13 +68992,13 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *481 + schema: *479 examples: default: value: @@ -69008,7 +69026,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 requestBody: required: true content: @@ -69036,7 +69054,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -69062,7 +69080,7 @@ paths: parameters: - *324 - *325 - - *150 + - *151 responses: '204': description: Response @@ -69561,7 +69579,7 @@ paths: - version - url additionalProperties: false - metadata: &482 + metadata: &480 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -69594,7 +69612,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *482 + metadata: *480 resolved: type: object description: A collection of resolved package dependencies. @@ -69607,7 +69625,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *482 + metadata: *480 relationship: type: string description: A notation of whether a dependency is requested @@ -69777,9 +69795,9 @@ paths: application/json: schema: type: array - items: *483 + items: *481 examples: - default: *484 + default: *482 headers: Link: *54 x-github: @@ -69927,7 +69945,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: simple-example: summary: Simple example @@ -70002,7 +70020,7 @@ paths: parameters: - *324 - *325 - - &485 + - &483 name: deployment_id description: deployment_id parameter in: path @@ -70014,7 +70032,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *481 examples: default: value: @@ -70081,7 +70099,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 responses: '204': description: Response @@ -70105,7 +70123,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 - *17 - *19 responses: @@ -70115,7 +70133,7 @@ paths: application/json: schema: type: array - items: &486 + items: &484 title: Deployment Status description: The status of a deployment. type: object @@ -70278,7 +70296,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 requestBody: required: true content: @@ -70353,9 +70371,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: &487 + default: &485 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -70413,7 +70431,7 @@ paths: parameters: - *324 - *325 - - *485 + - *483 - name: status_id in: path required: true @@ -70424,9 +70442,9 @@ paths: description: Response content: application/json: - schema: *486 + schema: *484 examples: - default: *487 + default: *485 '404': *6 x-github: githubCloudOnly: false @@ -70527,7 +70545,7 @@ paths: type: integer environments: type: array - items: &489 + items: &487 title: Environment description: Details of a deployment environment type: object @@ -70579,7 +70597,7 @@ paths: type: type: string example: wait_timer - wait_timer: &491 + wait_timer: &489 type: integer example: 30 description: The amount of time to delay a job after @@ -70616,11 +70634,11 @@ paths: items: type: object properties: - type: *488 + type: *486 reviewer: anyOf: - *4 - - *178 + - *179 required: - id - node_id @@ -70640,7 +70658,7 @@ paths: - id - node_id - type - deployment_branch_policy: &492 + deployment_branch_policy: &490 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -70758,7 +70776,7 @@ paths: parameters: - *324 - *325 - - &490 + - &488 name: environment_name in: path required: true @@ -70771,9 +70789,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: &493 + default: &491 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -70859,7 +70877,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: false content: @@ -70868,7 +70886,7 @@ paths: type: object nullable: true properties: - wait_timer: *491 + wait_timer: *489 prevent_self_review: type: boolean example: false @@ -70885,13 +70903,13 @@ paths: items: type: object properties: - type: *488 + type: *486 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *492 + deployment_branch_policy: *490 additionalProperties: false examples: default: @@ -70911,9 +70929,9 @@ paths: description: Response content: application/json: - schema: *489 + schema: *487 examples: - default: *493 + default: *491 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -70939,7 +70957,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 responses: '204': description: Default response @@ -70966,7 +70984,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 - *17 - *19 responses: @@ -70984,7 +71002,7 @@ paths: example: 2 branch_policies: type: array - items: &494 + items: &492 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -71043,7 +71061,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: true content: @@ -71089,9 +71107,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - example-wildcard: &495 + example-wildcard: &493 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -71135,8 +71153,8 @@ paths: parameters: - *324 - *325 - - *490 - - &496 + - *488 + - &494 name: branch_policy_id in: path required: true @@ -71148,9 +71166,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - default: *495 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71171,8 +71189,8 @@ paths: parameters: - *324 - *325 - - *490 - - *496 + - *488 + - *494 requestBody: required: true content: @@ -71200,9 +71218,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *492 examples: - default: *495 + default: *493 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71223,8 +71241,8 @@ paths: parameters: - *324 - *325 - - *490 - - *496 + - *488 + - *494 responses: '204': description: Response @@ -71249,7 +71267,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *490 + - *488 - *325 - *324 responses: @@ -71267,7 +71285,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &497 + items: &495 title: Deployment protection rule description: Deployment protection rule type: object @@ -71286,7 +71304,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &498 + app: &496 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -71385,7 +71403,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: - - *490 + - *488 - *325 - *324 requestBody: @@ -71408,9 +71426,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *497 + schema: *495 examples: - default: &499 + default: &497 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -71445,7 +71463,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: - - *490 + - *488 - *325 - *324 - *19 @@ -71466,7 +71484,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *498 + items: *496 examples: default: value: @@ -71503,8 +71521,8 @@ paths: parameters: - *324 - *325 - - *490 - - &500 + - *488 + - &498 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -71516,9 +71534,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *495 examples: - default: *499 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71539,10 +71557,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *490 + - *488 - *325 - *324 - - *500 + - *498 responses: '204': description: Response @@ -71570,7 +71588,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 - *17 - *19 responses: @@ -71588,9 +71606,9 @@ paths: type: integer secrets: type: array - items: *372 + items: *370 examples: - default: *373 + default: *371 headers: Link: *54 x-github: @@ -71617,15 +71635,15 @@ paths: parameters: - *324 - *325 - - *490 + - *488 responses: '200': description: Response content: application/json: - schema: *374 + schema: *372 examples: - default: *375 + default: *373 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71649,16 +71667,16 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 responses: '200': description: Response content: application/json: - schema: *372 + schema: *370 examples: - default: *501 + default: *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71682,8 +71700,8 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 requestBody: required: true content: @@ -71714,7 +71732,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -71742,8 +71760,8 @@ paths: parameters: - *324 - *325 - - *490 - - *150 + - *488 + - *151 responses: '204': description: Default response @@ -71770,8 +71788,8 @@ paths: parameters: - *324 - *325 - - *490 - - *343 + - *488 + - *341 - *19 responses: '200': @@ -71788,9 +71806,9 @@ paths: type: integer variables: type: array - items: *376 + items: *374 examples: - default: *377 + default: *375 headers: Link: *54 x-github: @@ -71815,7 +71833,7 @@ paths: parameters: - *324 - *325 - - *490 + - *488 requestBody: required: true content: @@ -71842,7 +71860,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -71869,16 +71887,16 @@ paths: parameters: - *324 - *325 - - *490 - - *153 + - *488 + - *154 responses: '200': description: Response content: application/json: - schema: *376 + schema: *374 examples: - default: *502 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71901,8 +71919,8 @@ paths: parameters: - *324 - *325 - - *153 - - *490 + - *154 + - *488 requestBody: required: true content: @@ -71946,8 +71964,8 @@ paths: parameters: - *324 - *325 - - *153 - - *490 + - *154 + - *488 responses: '204': description: Response @@ -72061,7 +72079,7 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: default: value: @@ -72231,9 +72249,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 '400': *14 '422': *15 '403': *29 @@ -72314,8 +72332,8 @@ paths: application/json: schema: oneOf: - - *111 - - *503 + - *112 + - *501 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72550,7 +72568,7 @@ paths: description: Response content: application/json: - schema: &504 + schema: &502 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -72766,13 +72784,13 @@ paths: parameters: - *324 - *325 - - *458 + - *456 responses: '200': description: Response content: application/json: - schema: *504 + schema: *502 examples: default: value: @@ -72830,7 +72848,7 @@ paths: parameters: - *324 - *325 - - &505 + - &503 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. @@ -72847,7 +72865,7 @@ paths: application/json: schema: type: array - items: &506 + items: &504 title: Git Reference description: Git references within a repository type: object @@ -72924,15 +72942,15 @@ paths: parameters: - *324 - *325 - - *505 + - *503 responses: '200': description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: &507 + default: &505 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -72991,9 +73009,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: *507 + default: *505 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -73021,7 +73039,7 @@ paths: parameters: - *324 - *325 - - *505 + - *503 requestBody: required: true content: @@ -73050,9 +73068,9 @@ paths: description: Response content: application/json: - schema: *506 + schema: *504 examples: - default: *507 + default: *505 '422': *15 '409': *47 x-github: @@ -73072,7 +73090,7 @@ paths: parameters: - *324 - *325 - - *505 + - *503 responses: '204': description: Response @@ -73195,7 +73213,7 @@ paths: description: Response content: application/json: - schema: &509 + schema: &507 title: Git Tag description: Metadata for a Git tag type: object @@ -73246,7 +73264,7 @@ paths: - sha - type - url - verification: *508 + verification: *506 required: - sha - url @@ -73256,7 +73274,7 @@ paths: - tag - message examples: - default: &510 + default: &508 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -73341,9 +73359,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *507 examples: - default: *510 + default: *508 '404': *6 '409': *47 x-github: @@ -73441,7 +73459,7 @@ paths: description: Response content: application/json: - schema: &511 + schema: &509 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -73561,7 +73579,7 @@ paths: description: Response content: application/json: - schema: *511 + schema: *509 examples: default-response: summary: Default response @@ -73631,7 +73649,7 @@ paths: application/json: schema: type: array - items: &512 + items: &510 title: Webhook description: Webhooks for repositories. type: object @@ -73685,7 +73703,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &753 + last_response: &752 title: Hook Response type: object properties: @@ -73812,9 +73830,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: &513 + default: &511 value: type: Repository id: 12345678 @@ -73864,15 +73882,15 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '200': description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '404': *6 x-github: githubCloudOnly: false @@ -73894,7 +73912,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 requestBody: required: true content: @@ -73939,9 +73957,9 @@ paths: description: Response content: application/json: - schema: *512 + schema: *510 examples: - default: *513 + default: *511 '422': *15 '404': *6 x-github: @@ -73964,7 +73982,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -73990,7 +74008,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '200': description: Response @@ -74019,7 +74037,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 requestBody: required: false content: @@ -74065,9 +74083,9 @@ paths: parameters: - *324 - *325 - - *193 - - *17 - *194 + - *17 + - *195 responses: '200': description: Response @@ -74075,9 +74093,9 @@ paths: application/json: schema: type: array - items: *195 + items: *196 examples: - default: *196 + default: *197 '400': *14 '422': *15 x-github: @@ -74098,16 +74116,16 @@ paths: parameters: - *324 - *325 - - *193 + - *194 - *16 responses: '200': description: Response content: application/json: - schema: *197 + schema: *198 examples: - default: *198 + default: *199 '400': *14 '422': *15 x-github: @@ -74128,7 +74146,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 - *16 responses: '202': *39 @@ -74153,7 +74171,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -74180,7 +74198,7 @@ paths: parameters: - *324 - *325 - - *193 + - *194 responses: '204': description: Response @@ -74253,7 +74271,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '409': *47 x-github: githubCloudOnly: false @@ -74274,7 +74292,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '409': *47 x-github: githubCloudOnly: false @@ -74336,7 +74354,7 @@ paths: description: Response content: application/json: - schema: &514 + schema: &512 title: Import description: A repository import from an external source. type: object @@ -74435,7 +74453,7 @@ paths: - html_url - authors_url examples: - default: &517 + default: &515 value: vcs: subversion use_lfs: true @@ -74451,7 +74469,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': &515 + '503': &513 description: Unavailable due to service under maintenance. content: application/json: @@ -74529,7 +74547,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: default: value: @@ -74554,7 +74572,7 @@ paths: type: string '422': *15 '404': *6 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74632,7 +74650,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: example-1: summary: Example 1 @@ -74680,7 +74698,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': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74708,7 +74726,7 @@ paths: responses: '204': description: Response - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74736,7 +74754,7 @@ paths: parameters: - *324 - *325 - - &689 + - &688 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -74750,7 +74768,7 @@ paths: application/json: schema: type: array - items: &516 + items: &514 title: Porter Author description: Porter Author type: object @@ -74804,7 +74822,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': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74860,7 +74878,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *514 examples: default: value: @@ -74873,7 +74891,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74939,7 +74957,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74995,11 +75013,11 @@ paths: description: Response content: application/json: - schema: *514 + schema: *512 examples: - default: *517 + default: *515 '422': *15 - '503': *515 + '503': *513 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75031,8 +75049,8 @@ paths: application/json: schema: *22 examples: - default: *518 - '301': *333 + default: *516 + '301': *331 '404': *6 x-github: githubCloudOnly: false @@ -75061,12 +75079,12 @@ paths: application/json: schema: anyOf: - - *211 + - *212 - type: object properties: {} additionalProperties: false examples: - default: &520 + default: &518 value: limit: collaborators_only origin: repository @@ -75097,7 +75115,7 @@ paths: required: true content: application/json: - schema: *519 + schema: *517 examples: default: summary: Example request body @@ -75109,9 +75127,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: - default: *520 + default: *518 '409': description: Response x-github: @@ -75168,9 +75186,9 @@ paths: application/json: schema: type: array - items: *521 + items: *519 examples: - default: &682 + default: &681 value: - id: 1 repository: @@ -75303,7 +75321,7 @@ paths: parameters: - *324 - *325 - - *215 + - *216 requestBody: required: false content: @@ -75332,7 +75350,7 @@ paths: description: Response content: application/json: - schema: *521 + schema: *519 examples: default: value: @@ -75465,7 +75483,7 @@ paths: parameters: - *324 - *325 - - *215 + - *216 responses: '204': description: Response @@ -75545,7 +75563,7 @@ paths: required: false schema: type: string - - *219 + - *220 - name: sort description: What to sort results by. in: query @@ -75570,7 +75588,7 @@ paths: type: array items: *82 examples: - default: &530 + default: &529 value: - id: 1 node_id: MDU6SXNzdWUx @@ -75718,7 +75736,7 @@ paths: state_reason: completed headers: Link: *54 - '301': *333 + '301': *331 '422': *15 '404': *6 x-github: @@ -75832,7 +75850,7 @@ paths: application/json: schema: *82 examples: - default: &527 + default: &526 value: id: 1 node_id: MDU6SXNzdWUx @@ -75988,7 +76006,7 @@ paths: '422': *15 '503': *104 '404': *6 - '410': *330 + '410': *520 x-github: triggersNotification: true githubCloudOnly: false @@ -76038,9 +76056,9 @@ paths: application/json: schema: type: array - items: *522 + items: *521 examples: - default: &529 + default: &528 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76106,9 +76124,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: &523 + default: &522 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -76186,9 +76204,9 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: *523 + default: *522 '422': *15 x-github: githubCloudOnly: false @@ -76378,7 +76396,7 @@ paths: application/json: schema: type: array - items: &526 + items: &525 title: Issue Event description: Issue Event type: object @@ -76421,8 +76439,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *524 - required: *525 + properties: *523 + required: *524 nullable: true label: title: Issue Event Label @@ -76466,7 +76484,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *178 + requested_team: *179 dismissed_review: title: Issue Event Dismissed Review type: object @@ -76741,7 +76759,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *525 examples: default: value: @@ -76934,7 +76952,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *330 + '410': *520 '403': *29 x-github: githubCloudOnly: false @@ -76970,7 +76988,7 @@ paths: parameters: - *324 - *325 - - &528 + - &527 name: issue_number description: The number that identifies the issue. in: path @@ -76984,10 +77002,10 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '404': *6 - '410': *330 + '410': *520 '304': *37 x-github: githubCloudOnly: false @@ -77014,7 +77032,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -77120,13 +77138,13 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 '422': *15 '503': *104 '403': *29 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77146,7 +77164,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -77174,7 +77192,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77192,7 +77210,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: content: application/json: @@ -77219,7 +77237,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77243,7 +77261,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: assignee in: path required: true @@ -77285,7 +77303,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *72 - *17 - *19 @@ -77296,13 +77314,13 @@ paths: application/json: schema: type: array - items: *522 + items: *521 examples: - default: *529 + default: *528 headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77333,7 +77351,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -77355,16 +77373,16 @@ paths: description: Response content: application/json: - schema: *522 + schema: *521 examples: - default: *523 + default: *522 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -77394,7 +77412,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77406,12 +77424,12 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77441,7 +77459,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -77465,15 +77483,15 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *333 + '301': *331 '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -77506,7 +77524,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -77520,13 +77538,13 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *330 + '410': *520 x-github: triggersNotification: true githubCloudOnly: false @@ -77554,7 +77572,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77566,12 +77584,12 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77590,7 +77608,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -77604,7 +77622,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &533 + - &532 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -77658,7 +77676,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &534 + - &533 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -77794,7 +77812,7 @@ paths: - performed_via_github_app - assignee - assigner - - &535 + - &534 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -77845,7 +77863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &536 + - &535 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -77896,7 +77914,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &537 + - &536 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -77950,7 +77968,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &538 + - &537 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -77984,7 +78002,7 @@ paths: properties: *67 required: *68 review_requester: *4 - requested_team: *178 + requested_team: *179 requested_reviewer: *4 required: - review_requester @@ -77997,7 +78015,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &539 + - &538 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -78031,7 +78049,7 @@ paths: properties: *67 required: *68 review_requester: *4 - requested_team: *178 + requested_team: *179 requested_reviewer: *4 required: - review_requester @@ -78044,7 +78062,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &540 + - &539 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -78104,7 +78122,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &541 + - &540 title: Locked Issue Event description: Locked Issue Event type: object @@ -78152,7 +78170,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &542 + - &541 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -78218,7 +78236,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &543 + - &542 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -78284,7 +78302,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &544 + - &543 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -78350,7 +78368,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &545 + - &544 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -78441,7 +78459,7 @@ paths: color: red headers: Link: *54 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78460,7 +78478,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -78470,7 +78488,7 @@ paths: application/json: schema: type: array - items: &531 + items: &530 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -78517,7 +78535,7 @@ paths: - color - default examples: - default: &532 + default: &531 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78535,9 +78553,9 @@ paths: default: false headers: Link: *54 - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78556,7 +78574,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78615,12 +78633,12 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 - '301': *333 + default: *531 + '301': *331 '404': *6 - '410': *330 + '410': *520 '422': *15 x-github: githubCloudOnly: false @@ -78639,7 +78657,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78699,12 +78717,12 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 - '301': *333 + default: *531 + '301': *331 '404': *6 - '410': *330 + '410': *520 '422': *15 x-github: githubCloudOnly: false @@ -78723,13 +78741,13 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '204': description: Response - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78750,7 +78768,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - name: name in: path required: true @@ -78763,7 +78781,7 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: default: value: @@ -78774,9 +78792,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *333 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78798,7 +78816,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: false content: @@ -78826,7 +78844,7 @@ paths: '204': description: Response '403': *29 - '410': *330 + '410': *520 '404': *6 '422': *15 x-github: @@ -78846,7 +78864,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '204': description: Response @@ -78878,7 +78896,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 responses: '200': description: Response @@ -78886,10 +78904,10 @@ paths: application/json: schema: *82 examples: - default: *527 - '301': *333 + default: *526 + '301': *331 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78908,7 +78926,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - 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. @@ -78940,7 +78958,7 @@ paths: headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78960,7 +78978,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79025,7 +79043,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *320 responses: '204': @@ -79057,7 +79075,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79081,7 +79099,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -79116,7 +79134,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -79128,11 +79146,11 @@ paths: type: array items: *82 examples: - default: *530 + default: *529 headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79162,7 +79180,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79191,14 +79209,14 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *330 + '410': *520 '422': *15 '404': *6 x-github: @@ -79220,7 +79238,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 requestBody: required: true content: @@ -79253,7 +79271,7 @@ paths: application/json: schema: *82 examples: - default: *527 + default: *526 '403': *29 '404': *6 '422': *7 @@ -79277,7 +79295,7 @@ paths: parameters: - *324 - *325 - - *528 + - *527 - *17 - *19 responses: @@ -79292,6 +79310,7 @@ paths: description: Timeline Event type: object anyOf: + - *532 - *533 - *534 - *535 @@ -79304,7 +79323,6 @@ paths: - *542 - *543 - *544 - - *545 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -79613,7 +79631,7 @@ paths: type: string comments: type: array - items: &567 + items: &566 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -79822,7 +79840,7 @@ paths: type: string comments: type: array - items: *456 + items: *454 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -80111,7 +80129,7 @@ paths: headers: Link: *54 '404': *6 - '410': *330 + '410': *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80139,7 +80157,7 @@ paths: application/json: schema: type: array - items: &546 + items: &545 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -80242,9 +80260,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *545 examples: - default: &547 + default: &546 value: id: 1 key: ssh-rsa AAA... @@ -80280,7 +80298,7 @@ paths: parameters: - *324 - *325 - - &548 + - &547 name: key_id description: The unique identifier of the key. in: path @@ -80292,9 +80310,9 @@ paths: description: Response content: application/json: - schema: *546 + schema: *545 examples: - default: *547 + default: *546 '404': *6 x-github: githubCloudOnly: false @@ -80314,7 +80332,7 @@ paths: parameters: - *324 - *325 - - *548 + - *547 responses: '204': description: Response @@ -80345,9 +80363,9 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 + default: *531 headers: Link: *54 '404': *6 @@ -80405,9 +80423,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: - default: &549 + default: &548 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80451,9 +80469,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: - default: *549 + default: *548 '404': *6 x-github: githubCloudOnly: false @@ -80510,7 +80528,7 @@ paths: description: Response content: application/json: - schema: *531 + schema: *530 examples: default: value: @@ -80605,7 +80623,7 @@ paths: parameters: - *324 - *325 - - *432 + - *430 responses: '200': description: Response @@ -80851,9 +80869,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *457 + schema: *455 examples: - default: *550 + default: *549 '204': description: Response when already merged '404': @@ -80920,7 +80938,7 @@ paths: application/json: schema: type: array - items: &551 + items: &550 title: Milestone description: A collection of related issues and pull requests. type: object @@ -81022,9 +81040,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: &552 + default: &551 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -81085,7 +81103,7 @@ paths: parameters: - *324 - *325 - - &553 + - &552 name: milestone_number description: The number that identifies the milestone. in: path @@ -81097,9 +81115,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: *552 + default: *551 '404': *6 x-github: githubCloudOnly: false @@ -81118,7 +81136,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 requestBody: required: false content: @@ -81156,9 +81174,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *550 examples: - default: *552 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81176,7 +81194,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 responses: '204': description: Response @@ -81199,7 +81217,7 @@ paths: parameters: - *324 - *325 - - *553 + - *552 - *17 - *19 responses: @@ -81209,9 +81227,9 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: - default: *532 + default: *531 headers: Link: *54 x-github: @@ -81232,10 +81250,10 @@ paths: parameters: - *324 - *325 + - *553 - *554 - - *555 - *72 - - *556 + - *555 - *17 - *19 responses: @@ -81247,7 +81265,7 @@ paths: type: array items: *95 examples: - default: *557 + default: *556 headers: Link: *54 x-github: @@ -81337,7 +81355,7 @@ paths: description: Response content: application/json: - schema: &558 + schema: &557 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -81462,7 +81480,7 @@ paths: - custom_404 - public examples: - default: &559 + default: &558 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -81558,9 +81576,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *557 examples: - default: *559 + default: *558 '422': *15 '409': *47 x-github: @@ -81721,7 +81739,7 @@ paths: application/json: schema: type: array - items: &560 + items: &559 title: Page Build description: Page Build type: object @@ -81868,9 +81886,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: &561 + default: &560 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -81930,9 +81948,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: *561 + default: *560 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82060,7 +82078,7 @@ paths: parameters: - *324 - *325 - - &562 + - &561 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -82120,9 +82138,9 @@ paths: parameters: - *324 - *325 - - *562 + - *561 responses: - '204': *172 + '204': *173 '404': *6 x-github: githubCloudOnly: false @@ -82379,7 +82397,7 @@ paths: description: Empty response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -82447,7 +82465,7 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '422': *14 x-github: githubCloudOnly: false @@ -82469,155 +82487,13 @@ paths: - *324 - *325 responses: - '204': *172 + '204': *173 '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: - - *324 - - *325 - - 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: *250 - 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: *54 - '401': *25 - '403': *29 - '404': *6 - '410': *330 - '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: - - *324 - - *325 - 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: *250 - examples: - default: *329 - '401': *25 - '403': *29 - '404': *6 - '410': *330 - '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 @@ -82642,7 +82518,7 @@ paths: type: array items: *102 examples: - default: *563 + default: *562 '403': *29 '404': *6 x-github: @@ -82681,7 +82557,7 @@ paths: required: - properties examples: - default: *564 + default: *563 responses: '204': description: No Content when custom property values are successfully created @@ -82780,9 +82656,9 @@ paths: application/json: schema: type: array - items: *461 + items: *459 examples: - default: *565 + default: *564 headers: Link: *54 '304': *37 @@ -82880,7 +82756,7 @@ paths: description: Response content: application/json: - schema: &569 + schema: &568 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -83094,7 +82970,7 @@ paths: - review_comment - self author_association: *69 - auto_merge: *566 + auto_merge: *565 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -83186,7 +83062,7 @@ paths: - merged_by - review_comments examples: - default: &570 + default: &569 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -83743,9 +83619,9 @@ paths: application/json: schema: type: array - items: *567 + items: *566 examples: - default: &572 + default: &571 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83830,9 +83706,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: - default: &568 + default: &567 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -83931,9 +83807,9 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: - default: *568 + default: *567 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84136,7 +84012,7 @@ paths: parameters: - *324 - *325 - - &571 + - &570 name: pull_number description: The number that identifies the pull request. in: path @@ -84149,9 +84025,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *569 + schema: *568 examples: - default: *570 + default: *569 '304': *37 '404': *6 '406': @@ -84188,7 +84064,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -84230,9 +84106,9 @@ paths: description: Response content: application/json: - schema: *569 + schema: *568 examples: - default: *570 + default: *569 '422': *15 '403': *29 x-github: @@ -84256,7 +84132,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -84316,17 +84192,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -84358,7 +84234,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *92 - name: direction description: The direction to sort results. Ignored without `sort` parameter. @@ -84379,9 +84255,9 @@ paths: application/json: schema: type: array - items: *567 + items: *566 examples: - default: *572 + default: *571 headers: Link: *54 x-github: @@ -84416,7 +84292,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -84521,7 +84397,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: example-for-a-multi-line-comment: value: @@ -84611,7 +84487,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *81 requestBody: required: true @@ -84634,7 +84510,7 @@ paths: description: Response content: application/json: - schema: *567 + schema: *566 examples: default: value: @@ -84722,7 +84598,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -84732,9 +84608,9 @@ paths: application/json: schema: type: array - items: *457 + items: *455 examples: - default: *573 + default: *572 headers: Link: *54 x-github: @@ -84766,7 +84642,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -84776,7 +84652,7 @@ paths: application/json: schema: type: array - items: *470 + items: *468 examples: default: value: @@ -84816,7 +84692,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 responses: '204': description: Response if pull request has been merged @@ -84841,7 +84717,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -84954,7 +84830,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 responses: '200': description: Response @@ -84970,7 +84846,7 @@ paths: items: *4 teams: type: array - items: *178 + items: *179 required: - users - teams @@ -85031,7 +84907,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -85068,7 +84944,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -85606,7 +85482,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: true content: @@ -85640,7 +85516,7 @@ paths: description: Response content: application/json: - schema: *461 + schema: *459 examples: default: value: @@ -86147,7 +86023,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 - *17 - *19 responses: @@ -86157,7 +86033,7 @@ paths: application/json: schema: type: array - items: &574 + items: &573 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -86310,7 +86186,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -86396,9 +86272,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &576 + default: &575 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86463,8 +86339,8 @@ paths: parameters: - *324 - *325 - - *571 - - &575 + - *570 + - &574 name: review_id description: The unique identifier of the review. in: path @@ -86476,9 +86352,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: &577 + default: &576 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -86539,8 +86415,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -86563,7 +86439,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: default: value: @@ -86627,16 +86503,16 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 responses: '200': description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *576 + default: *575 '422': *7 '404': *6 x-github: @@ -86665,8 +86541,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 - *17 - *19 responses: @@ -86903,8 +86779,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -86932,7 +86808,7 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: default: value: @@ -86997,8 +86873,8 @@ paths: parameters: - *324 - *325 - - *571 - - *575 + - *570 + - *574 requestBody: required: true content: @@ -87033,9 +86909,9 @@ paths: description: Response content: application/json: - schema: *574 + schema: *573 examples: - default: *577 + default: *576 '404': *6 '422': *7 '403': *29 @@ -87059,7 +86935,7 @@ paths: parameters: - *324 - *325 - - *571 + - *570 requestBody: required: false content: @@ -87136,9 +87012,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: &579 + default: &578 value: type: file encoding: base64 @@ -87201,9 +87077,9 @@ paths: description: Response content: application/json: - schema: *578 + schema: *577 examples: - default: *579 + default: *578 '404': *6 '422': *15 x-github: @@ -87236,7 +87112,7 @@ paths: application/json: schema: type: array - items: &580 + items: &579 title: Release description: A release. type: object @@ -87307,7 +87183,7 @@ paths: author: *4 assets: type: array - items: &581 + items: &580 title: Release Asset description: Data related to a release. type: object @@ -87571,9 +87447,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: &584 + default: &583 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -87680,7 +87556,7 @@ paths: parameters: - *324 - *325 - - &582 + - &581 name: asset_id description: The unique identifier of the asset. in: path @@ -87692,9 +87568,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *580 examples: - default: &583 + default: &582 value: url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1 browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip @@ -87729,7 +87605,7 @@ paths: type: User site_admin: false '404': *6 - '302': *472 + '302': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87747,7 +87623,7 @@ paths: parameters: - *324 - *325 - - *582 + - *581 requestBody: required: false content: @@ -87775,9 +87651,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *580 examples: - default: *583 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87795,7 +87671,7 @@ paths: parameters: - *324 - *325 - - *582 + - *581 responses: '204': description: Response @@ -87912,9 +87788,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87945,9 +87821,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 '404': *6 x-github: githubCloudOnly: false @@ -87971,7 +87847,7 @@ paths: parameters: - *324 - *325 - - &585 + - &584 name: release_id description: The unique identifier of the release. in: path @@ -87985,9 +87861,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: *580 + schema: *579 examples: - default: *584 + default: *583 '401': description: Unauthorized x-github: @@ -88007,7 +87883,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 requestBody: required: false content: @@ -88071,9 +87947,9 @@ paths: description: Response content: application/json: - schema: *580 + schema: *579 examples: - default: *584 + default: *583 '404': description: Not Found if the discussion category name is invalid content: @@ -88096,7 +87972,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 responses: '204': description: Response @@ -88118,7 +87994,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - *17 - *19 responses: @@ -88128,7 +88004,7 @@ paths: application/json: schema: type: array - items: *581 + items: *580 examples: default: value: @@ -88211,7 +88087,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - name: name in: query required: true @@ -88237,7 +88113,7 @@ paths: description: Response for successful upload content: application/json: - schema: *581 + schema: *580 examples: response-for-successful-upload: value: @@ -88294,7 +88170,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. @@ -88343,7 +88219,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 requestBody: required: true content: @@ -88406,7 +88282,7 @@ paths: parameters: - *324 - *325 - - *585 + - *584 - *320 responses: '204': @@ -88433,7 +88309,7 @@ paths: parameters: - *324 - *325 - - *394 + - *392 - *17 - *19 responses: @@ -88450,7 +88326,7 @@ paths: oneOf: - allOf: - *275 - - &586 + - &585 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -88471,67 +88347,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *276 - - *586 + - *585 - allOf: - *277 - - *586 + - *585 - allOf: - *278 - - *586 + - *585 - allOf: - - *587 - *586 + - *585 - allOf: - *279 - - *586 + - *585 - allOf: - *280 - - *586 + - *585 - allOf: - *281 - - *586 + - *585 - allOf: - *282 - - *586 + - *585 - allOf: - *283 - - *586 + - *585 - allOf: - *284 - - *586 + - *585 - allOf: - *285 - - *586 + - *585 - allOf: - *286 - - *586 + - *585 - allOf: - *287 - - *586 + - *585 - allOf: - *288 - - *586 + - *585 - allOf: - *289 - - *586 + - *585 - allOf: - *290 - - *586 + - *585 - allOf: - *291 - - *586 + - *585 - allOf: - *292 - - *586 + - *585 - allOf: - *293 - - *586 + - *585 - allOf: - *294 - - *586 + - *585 - allOf: - - *588 - - *586 + - *587 + - *585 examples: default: value: @@ -88582,7 +88458,7 @@ paths: schema: type: boolean default: true - - *589 + - *588 responses: '200': description: Response @@ -88667,7 +88543,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *590 + items: *589 required: - name - enforcement @@ -88700,7 +88576,7 @@ paths: application/json: schema: *295 examples: - default: &600 + default: &599 value: id: 42 name: super cool ruleset @@ -88749,10 +88625,10 @@ paths: parameters: - *324 - *325 + - *590 - *591 - *592 - *593 - - *594 - *17 - *19 responses: @@ -88760,9 +88636,9 @@ paths: description: Response content: application/json: - schema: *595 + schema: *594 examples: - default: *596 + default: *595 '404': *6 '500': *103 x-github: @@ -88785,15 +88661,15 @@ paths: parameters: - *324 - *325 - - *597 + - *596 responses: '200': description: Response content: application/json: - schema: *598 + schema: *597 examples: - default: *599 + default: *598 '404': *6 '500': *103 x-github: @@ -88844,7 +88720,7 @@ paths: application/json: schema: *295 examples: - default: *600 + default: *599 '404': *6 '500': *103 put: @@ -88897,7 +88773,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *590 + items: *589 examples: default: value: @@ -88927,7 +88803,7 @@ paths: application/json: schema: *295 examples: - default: *600 + default: *599 '404': *6 '500': *103 delete: @@ -88988,7 +88864,7 @@ paths: type: array items: *298 examples: - default: *601 + default: *600 '404': *6 '500': *103 x-github: @@ -89026,7 +88902,7 @@ paths: description: Response content: application/json: - schema: *602 + schema: *601 examples: default: value: @@ -89083,19 +88959,19 @@ paths: parameters: - *324 - *325 + - *602 - *603 - *604 - *605 - - *606 - *48 - *19 - *17 + - *606 - *607 - *608 - *609 - *610 - *611 - - *612 responses: '200': description: Response @@ -89103,11 +88979,11 @@ paths: application/json: schema: type: array - items: &616 + items: &615 type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -89115,15 +88991,15 @@ paths: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *613 - resolution: *614 + state: *612 + resolution: *613 resolved_at: type: string format: date-time @@ -89219,7 +89095,7 @@ paths: pull request. ' - oneOf: *615 + oneOf: *614 nullable: true has_more_locations: type: boolean @@ -89370,14 +89246,14 @@ paths: parameters: - *324 - *325 - - *426 - - *612 + - *424 + - *611 responses: '200': description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -89431,7 +89307,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 requestBody: required: true content: @@ -89439,15 +89315,16 @@ paths: schema: type: object properties: - state: *613 - resolution: *614 + state: *612 + resolution: *613 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -89458,7 +89335,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *615 examples: default: value: @@ -89535,7 +89412,7 @@ paths: parameters: - *324 - *325 - - *426 + - *424 - *19 - *17 responses: @@ -89546,7 +89423,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &775 + items: &774 type: object properties: type: @@ -89572,6 +89449,7 @@ paths: example: commit details: oneOf: + - *616 - *617 - *618 - *619 @@ -89584,7 +89462,6 @@ paths: - *626 - *627 - *628 - - *629 examples: default: value: @@ -89679,14 +89556,14 @@ paths: schema: type: object properties: - reason: &631 + reason: &630 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *630 + placeholder_id: *629 required: - reason - placeholder_id @@ -89703,7 +89580,7 @@ paths: schema: type: object properties: - reason: *631 + reason: *630 expire_at: type: string format: date-time @@ -89765,7 +89642,7 @@ paths: properties: incremental_scans: type: array - items: &632 + items: &631 description: Information on a single scan performed by secret scanning on the repository type: object @@ -89791,15 +89668,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *632 + items: *631 backfill_scans: type: array - items: *632 + items: *631 custom_pattern_backfill_scans: type: array items: allOf: - - *632 + - *631 - type: object properties: pattern_name: @@ -89914,9 +89791,9 @@ paths: application/json: schema: type: array - items: *633 + items: *632 examples: - default: *634 + default: *633 '400': *14 '404': *6 x-github: @@ -90100,9 +89977,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: &636 + default: &635 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -90440,7 +90317,7 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: default: value: @@ -90589,15 +90466,15 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '200': description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: *636 + default: *635 '403': *29 '404': *6 x-github: @@ -90623,7 +90500,7 @@ paths: parameters: - *324 - *325 - - *635 + - *634 requestBody: required: true content: @@ -90782,17 +90659,17 @@ paths: description: Response content: application/json: - schema: *633 + schema: *632 examples: - default: *636 - add_credit: *636 + default: *635 + add_credit: *635 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *111 + schema: *112 examples: invalid_state_transition: value: @@ -90825,7 +90702,7 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '202': *39 '400': *14 @@ -90854,15 +90731,15 @@ paths: parameters: - *324 - *325 - - *635 + - *634 responses: '202': description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 '400': *14 '422': *15 '403': *29 @@ -90998,7 +90875,7 @@ paths: application/json: schema: type: array - items: &637 + items: &636 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -91011,7 +90888,7 @@ paths: - 1124 - -435 '202': *39 - '204': *172 + '204': *173 '422': description: Repository contains more than 10,000 commits x-github: @@ -91081,7 +90958,7 @@ paths: total: 89 week: 1336280400 '202': *39 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91183,7 +91060,7 @@ paths: d: 77 c: 10 '202': *39 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91371,7 +91248,7 @@ paths: application/json: schema: type: array - items: *637 + items: *636 examples: default: value: @@ -91384,7 +91261,7 @@ paths: - - 0 - 2 - 21 - '204': *172 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91459,7 +91336,7 @@ paths: description: Response content: application/json: - schema: *638 + schema: *637 examples: default: value: @@ -91553,7 +91430,7 @@ paths: description: if you subscribe to the repository content: application/json: - schema: &639 + schema: &638 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -91648,7 +91525,7 @@ paths: description: Response content: application/json: - schema: *639 + schema: *638 examples: default: value: @@ -91785,7 +91662,7 @@ paths: application/json: schema: type: array - items: &640 + items: &639 title: Tag protection description: Tag protection type: object @@ -91861,7 +91738,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *639 examples: default: value: @@ -91978,9 +91855,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - default: *233 + default: *234 headers: Link: *54 '404': *6 @@ -92009,7 +91886,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &640 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -92021,7 +91898,7 @@ paths: required: - names examples: - default: &642 + default: &641 value: names: - octocat @@ -92076,9 +91953,9 @@ paths: description: Response content: application/json: - schema: *641 + schema: *640 examples: - default: *642 + default: *641 '404': *6 '422': *7 x-github: @@ -92101,7 +91978,7 @@ paths: parameters: - *324 - *325 - - &643 + - &642 name: per description: The time frame to display results for. in: query @@ -92130,7 +92007,7 @@ paths: example: 128 clones: type: array - items: &644 + items: &643 title: Traffic type: object properties: @@ -92371,7 +92248,7 @@ paths: parameters: - *324 - *325 - - *643 + - *642 responses: '200': description: Response @@ -92390,7 +92267,7 @@ paths: example: 3782 views: type: array - items: *644 + items: *643 required: - uniques - count @@ -92504,7 +92381,7 @@ paths: description: Response content: application/json: - schema: *142 + schema: *143 examples: default: value: @@ -92909,9 +92786,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -92952,7 +92829,7 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: default: value: @@ -93141,7 +93018,7 @@ paths: html_url: type: string format: uri - repository: *142 + repository: *143 score: type: number file_size: @@ -93159,7 +93036,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &645 + text_matches: &644 title: Search Result Text Matches type: array items: @@ -93321,7 +93198,7 @@ paths: enum: - author-date - committer-date - - &646 + - &645 name: order description: Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter @@ -93392,7 +93269,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true comment_count: type: integer @@ -93412,7 +93289,7 @@ paths: url: type: string format: uri - verification: *508 + verification: *506 required: - author - committer @@ -93431,7 +93308,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *392 + properties: *390 nullable: true parents: type: array @@ -93444,12 +93321,12 @@ paths: type: string sha: type: string - repository: *142 + repository: *143 score: type: number node_id: type: string - text_matches: *645 + text_matches: *644 required: - sha - node_id @@ -93641,7 +93518,7 @@ paths: - interactions - created - updated - - *646 + - *645 - *17 - *19 - name: advanced_search @@ -93738,11 +93615,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: type: string state_reason: @@ -93774,7 +93651,7 @@ paths: type: string format: date-time nullable: true - text_matches: *645 + text_matches: *644 pull_request: type: object properties: @@ -93818,7 +93695,7 @@ paths: timeline_url: type: string format: uri - type: *216 + type: *217 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -93999,7 +93876,7 @@ paths: enum: - created - updated - - *646 + - *645 - *17 - *19 responses: @@ -94043,7 +93920,7 @@ paths: nullable: true score: type: number - text_matches: *645 + text_matches: *644 required: - id - node_id @@ -94128,7 +94005,7 @@ paths: - forks - help-wanted-issues - updated - - *646 + - *645 - *17 - *19 responses: @@ -94367,7 +94244,7 @@ paths: - admin - pull - push - text_matches: *645 + text_matches: *644 temp_clone_token: type: string allow_merge_commit: @@ -94667,7 +94544,7 @@ paths: type: string format: uri nullable: true - text_matches: *645 + text_matches: *644 related: type: array nullable: true @@ -94858,7 +94735,7 @@ paths: - followers - repositories - joined - - *646 + - *645 - *17 - *19 responses: @@ -94962,7 +94839,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *645 + text_matches: *644 blog: type: string nullable: true @@ -95041,7 +94918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &650 + - &649 name: team_id description: The unique identifier of the team. in: path @@ -95082,7 +94959,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *650 + - *649 requestBody: required: true content: @@ -95182,7 +95059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *650 + - *649 responses: '204': description: Response @@ -95213,7 +95090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *650 + - *649 - *48 - *17 - *19 @@ -95226,7 +95103,7 @@ paths: type: array items: *311 examples: - default: *651 + default: *650 headers: Link: *54 x-github: @@ -95255,7 +95132,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *650 + - *649 requestBody: required: true content: @@ -95318,7 +95195,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *650 + - *649 - *313 responses: '200': @@ -95352,7 +95229,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *650 + - *649 - *313 requestBody: required: false @@ -95378,7 +95255,7 @@ paths: application/json: schema: *311 examples: - default: *652 + default: *651 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95403,7 +95280,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *650 + - *649 - *313 responses: '204': @@ -95433,7 +95310,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *650 + - *649 - *313 - *48 - *17 @@ -95447,7 +95324,7 @@ paths: type: array items: *314 examples: - default: *653 + default: *652 headers: Link: *54 x-github: @@ -95476,7 +95353,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 requestBody: required: true @@ -95528,7 +95405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 responses: @@ -95563,7 +95440,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 requestBody: @@ -95589,7 +95466,7 @@ paths: application/json: schema: *314 examples: - default: *654 + default: *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95614,7 +95491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 responses: @@ -95645,7 +95522,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 - name: content @@ -95704,7 +95581,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *650 + - *649 - *313 - *316 requestBody: @@ -95766,7 +95643,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *650 + - *649 - *313 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). @@ -95824,7 +95701,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *650 + - *649 - *313 requestBody: required: true @@ -95883,7 +95760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -95893,9 +95770,9 @@ paths: application/json: schema: type: array - items: *213 + items: *214 examples: - default: *214 + default: *215 headers: Link: *54 x-github: @@ -95921,7 +95798,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *650 + - *649 - name: role description: Filters members returned by their role in the team. in: query @@ -95972,7 +95849,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96009,7 +95886,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96049,7 +95926,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96086,7 +95963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 responses: '200': @@ -96095,7 +95972,7 @@ paths: application/json: schema: *321 examples: - response-if-user-is-a-team-maintainer: *655 + response-if-user-is-a-team-maintainer: *654 '404': *6 x-github: githubCloudOnly: false @@ -96128,7 +96005,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 requestBody: required: false @@ -96156,7 +96033,7 @@ paths: application/json: schema: *321 examples: - response-if-users-membership-with-team-is-now-pending: *656 + response-if-users-membership-with-team-is-now-pending: *655 '403': description: Forbidden if team synchronization is set up '422': @@ -96190,7 +96067,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *650 + - *649 - *59 responses: '204': @@ -96219,7 +96096,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96231,7 +96108,7 @@ paths: type: array items: *322 examples: - default: *657 + default: *656 headers: Link: *54 '404': *6 @@ -96257,7 +96134,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *650 + - *649 - *323 responses: '200': @@ -96266,7 +96143,7 @@ paths: application/json: schema: *322 examples: - default: *658 + default: *657 '404': description: Not Found if project is not managed by this team x-github: @@ -96290,7 +96167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *650 + - *649 - *323 requestBody: required: false @@ -96358,7 +96235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *650 + - *649 - *323 responses: '204': @@ -96386,7 +96263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96396,9 +96273,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '404': *6 @@ -96428,7 +96305,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *650 + - *649 - *324 - *325 responses: @@ -96436,7 +96313,7 @@ paths: description: Alternative response with extra repository information content: application/json: - schema: *659 + schema: *658 examples: alternative-response-with-extra-repository-information: value: @@ -96587,7 +96464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *650 + - *649 - *324 - *325 requestBody: @@ -96639,7 +96516,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *650 + - *649 - *324 - *325 responses: @@ -96666,7 +96543,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *650 + - *649 - *17 - *19 responses: @@ -96676,9 +96553,9 @@ paths: application/json: schema: type: array - items: *178 + items: *179 examples: - response-if-child-teams-exist: *660 + response-if-child-teams-exist: *659 headers: Link: *54 '404': *6 @@ -96711,7 +96588,7 @@ paths: application/json: schema: oneOf: - - &662 + - &661 title: Private User description: Private User type: object @@ -96914,7 +96791,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *661 + - *660 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -97067,7 +96944,7 @@ paths: description: Response content: application/json: - schema: *662 + schema: *661 examples: default: value: @@ -97270,9 +97147,9 @@ paths: type: integer codespaces: type: array - items: *221 + items: *222 examples: - default: *222 + default: *223 '304': *37 '500': *103 '401': *25 @@ -97411,17 +97288,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -97465,7 +97342,7 @@ paths: type: integer secrets: type: array - items: &663 + items: &662 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -97505,7 +97382,7 @@ paths: - visibility - selected_repositories_url examples: - default: *449 + default: *447 headers: Link: *54 x-github: @@ -97575,13 +97452,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 responses: '200': description: Response content: application/json: - schema: *663 + schema: *662 examples: default: value: @@ -97611,7 +97488,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 requestBody: required: true content: @@ -97656,7 +97533,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -97684,7 +97561,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *150 + - *151 responses: '204': description: Response @@ -97709,7 +97586,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *150 + - *151 responses: '200': description: Response @@ -97725,9 +97602,9 @@ paths: type: integer repositories: type: array - items: *142 + items: *143 examples: - default: *664 + default: *663 '401': *25 '403': *29 '404': *6 @@ -97752,7 +97629,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *150 + - *151 requestBody: required: true content: @@ -97806,7 +97683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *150 + - *151 - name: repository_id in: path required: true @@ -97839,7 +97716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *150 + - *151 - name: repository_id in: path required: true @@ -97871,15 +97748,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '304': *37 '500': *103 '401': *25 @@ -97905,7 +97782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 requestBody: required: false content: @@ -97935,9 +97812,9 @@ paths: description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '401': *25 '403': *29 '404': *6 @@ -97959,7 +97836,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '202': *39 '304': *37 @@ -97988,13 +97865,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '202': description: Response content: application/json: - schema: &665 + schema: &664 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -98035,7 +97912,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &666 + default: &665 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -98067,7 +97944,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *223 + - *224 - name: export_id in: path required: true @@ -98080,9 +97957,9 @@ paths: description: Response content: application/json: - schema: *665 + schema: *664 examples: - default: *666 + default: *665 '404': *6 x-github: githubCloudOnly: false @@ -98103,7 +97980,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *223 + - *224 responses: '200': description: Response @@ -98119,9 +97996,9 @@ paths: type: integer machines: type: array - items: *667 + items: *666 examples: - default: *668 + default: *667 '304': *37 '500': *103 '401': *25 @@ -98150,7 +98027,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *223 + - *224 requestBody: required: true content: @@ -98200,13 +98077,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *332 + repository: *330 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *447 - required: *448 + properties: *445 + required: *446 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -98980,15 +98857,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '304': *37 '500': *103 '400': *14 @@ -99020,15 +98897,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *223 + - *224 responses: '200': description: Response content: application/json: - schema: *221 + schema: *222 examples: - default: *446 + default: *444 '500': *103 '401': *25 '403': *29 @@ -99058,9 +98935,9 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: &679 + default: &678 value: - id: 197 name: hello_docker @@ -99161,7 +99038,7 @@ paths: application/json: schema: type: array - items: &669 + items: &668 title: Email description: Email type: object @@ -99226,9 +99103,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: &681 + default: &680 value: - email: octocat@github.com verified: true @@ -99303,7 +99180,7 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: default: value: @@ -99559,7 +99436,7 @@ paths: application/json: schema: type: array - items: &670 + items: &669 title: GPG Key description: A unique encryption key type: object @@ -99690,7 +99567,7 @@ paths: - subkeys - revoked examples: - default: &695 + default: &694 value: - id: 3 name: Octocat's GPG Key @@ -99775,9 +99652,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *669 examples: - default: &671 + default: &670 value: id: 3 name: Octocat's GPG Key @@ -99834,7 +99711,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &672 + - &671 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -99846,9 +99723,9 @@ paths: description: Response content: application/json: - schema: *670 + schema: *669 examples: - default: *671 + default: *670 '404': *6 '304': *37 '403': *29 @@ -99871,7 +99748,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *672 + - *671 responses: '204': description: Response @@ -100062,7 +99939,7 @@ paths: type: array items: *66 examples: - default: *134 + default: *135 headers: Link: *54 '404': *6 @@ -100087,7 +99964,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *131 + - *132 responses: '204': description: Response @@ -100113,7 +99990,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *131 + - *132 responses: '204': description: Response @@ -100147,12 +100024,12 @@ paths: application/json: schema: anyOf: - - *211 + - *212 - type: object properties: {} additionalProperties: false examples: - default: *212 + default: *213 '204': description: Response when there are no restrictions x-github: @@ -100176,7 +100053,7 @@ paths: required: true content: application/json: - schema: *519 + schema: *517 examples: default: value: @@ -100187,7 +100064,7 @@ paths: description: Response content: application/json: - schema: *211 + schema: *212 examples: default: value: @@ -100268,7 +100145,7 @@ paths: - closed - all default: open - - *219 + - *220 - name: sort description: What to sort results by. in: query @@ -100293,7 +100170,7 @@ paths: type: array items: *82 examples: - default: *220 + default: *221 headers: Link: *54 '404': *6 @@ -100326,7 +100203,7 @@ paths: application/json: schema: type: array - items: &673 + items: &672 title: Key description: Key type: object @@ -100427,9 +100304,9 @@ paths: description: Response content: application/json: - schema: *673 + schema: *672 examples: - default: &674 + default: &673 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -100462,15 +100339,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *548 + - *547 responses: '200': description: Response content: application/json: - schema: *673 + schema: *672 examples: - default: *674 + default: *673 '404': *6 '304': *37 '403': *29 @@ -100493,7 +100370,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *548 + - *547 responses: '204': description: Response @@ -100526,7 +100403,7 @@ paths: application/json: schema: type: array - items: &675 + items: &674 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -100594,7 +100471,7 @@ paths: - account - plan examples: - default: &676 + default: &675 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -100656,9 +100533,9 @@ paths: application/json: schema: type: array - items: *675 + items: *674 examples: - default: *676 + default: *675 headers: Link: *54 '304': *37 @@ -100698,7 +100575,7 @@ paths: application/json: schema: type: array - items: *225 + items: *226 examples: default: value: @@ -100806,7 +100683,7 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: default: value: @@ -100889,7 +100766,7 @@ paths: description: Response content: application/json: - schema: *225 + schema: *226 examples: default: value: @@ -100957,7 +100834,7 @@ paths: application/json: schema: type: array - items: *227 + items: *228 examples: default: value: @@ -101210,7 +101087,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -101390,7 +101267,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *228 + - *229 - name: exclude in: query required: false @@ -101403,7 +101280,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *228 examples: default: value: @@ -101597,7 +101474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *228 + - *229 responses: '302': description: Response @@ -101623,7 +101500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *228 + - *229 responses: '204': description: Response @@ -101652,8 +101529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *228 - - *677 + - *229 + - *676 responses: '204': description: Response @@ -101677,7 +101554,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *228 + - *229 - *17 - *19 responses: @@ -101687,9 +101564,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '404': *6 @@ -101768,7 +101645,7 @@ paths: - docker - nuget - container - - *678 + - *677 - *19 - *17 responses: @@ -101778,10 +101655,10 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 - '400': *680 + default: *678 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101801,16 +101678,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 responses: '200': description: Response content: application/json: - schema: *234 + schema: *235 examples: - default: &696 + default: &695 value: id: 40201 name: octo-name @@ -101923,8 +101800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 responses: '204': description: Response @@ -101954,8 +101831,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *236 - *237 + - *238 - name: token description: package token schema: @@ -101987,8 +101864,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: - - *236 - *237 + - *238 - *19 - *17 - name: state @@ -102008,7 +101885,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -102057,15 +101934,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '200': description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -102101,9 +101978,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '204': description: Response @@ -102133,9 +102010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 responses: '204': description: Response @@ -102147,97 +102024,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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: *250 - 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': *37 - '403': *29 - '401': *25 - '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 @@ -102263,9 +102049,9 @@ paths: application/json: schema: type: array - items: *669 + items: *668 examples: - default: *681 + default: *680 headers: Link: *54 '304': *37 @@ -102378,7 +102164,7 @@ paths: type: array items: *66 examples: - default: &688 + default: &687 summary: Default response value: - id: 1296269 @@ -102682,9 +102468,9 @@ paths: description: Response content: application/json: - schema: *332 + schema: *330 examples: - default: *334 + default: *332 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -102722,9 +102508,9 @@ paths: application/json: schema: type: array - items: *521 + items: *519 examples: - default: *682 + default: *681 headers: Link: *54 '304': *37 @@ -102747,7 +102533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *215 + - *216 responses: '204': description: Response @@ -102770,7 +102556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *215 + - *216 responses: '204': description: Response @@ -102803,7 +102589,7 @@ paths: application/json: schema: type: array - items: &683 + items: &682 title: Social account description: Social media account type: object @@ -102818,7 +102604,7 @@ paths: - provider - url examples: - default: &684 + default: &683 value: - provider: twitter url: https://twitter.com/github @@ -102880,9 +102666,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: *684 + default: *683 '422': *15 '304': *37 '404': *6 @@ -102969,7 +102755,7 @@ paths: application/json: schema: type: array - items: &685 + items: &684 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -102989,7 +102775,7 @@ paths: - title - created_at examples: - default: &711 + default: &710 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103055,9 +102841,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: &686 + default: &685 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -103088,7 +102874,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: - - &687 + - &686 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -103100,9 +102886,9 @@ paths: description: Response content: application/json: - schema: *685 + schema: *684 examples: - default: *686 + default: *685 '404': *6 '304': *37 '403': *29 @@ -103125,7 +102911,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: - - *687 + - *686 responses: '204': description: Response @@ -103154,7 +102940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &712 + - &711 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 @@ -103179,11 +102965,11 @@ paths: type: array items: *66 examples: - default-response: *688 + default-response: *687 application/vnd.github.v3.star+json: schema: type: array - items: &713 + items: &712 title: Starred Repository description: Starred Repository type: object @@ -103427,9 +103213,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 '304': *37 @@ -103552,10 +103338,10 @@ paths: application/json: schema: oneOf: - - *662 - *661 + - *660 examples: - default-response: &690 + default-response: &689 summary: Default response value: login: octocat @@ -103590,7 +103376,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &691 + response-with-git-hub-plan-information: &690 summary: Response with GitHub plan information value: login: octocat @@ -103650,7 +103436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *689 + - *688 - *17 responses: '200': @@ -103699,11 +103485,11 @@ paths: application/json: schema: oneOf: - - *662 - *661 + - *660 examples: - default-response: *690 - response-with-git-hub-plan-information: *691 + default-response: *689 + response-with-git-hub-plan-information: *690 '404': *6 x-github: githubCloudOnly: false @@ -103753,8 +103539,8 @@ paths: required: - subject_digests examples: - default: *692 - withPredicateType: *693 + default: *691 + withPredicateType: *692 responses: '200': description: Response @@ -103807,7 +103593,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *694 + default: *693 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -104012,12 +103798,12 @@ paths: initiator: type: string examples: - default: *388 + default: *386 '201': description: Response content: application/json: - schema: *151 + schema: *152 examples: default: value: @@ -104051,9 +103837,9 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 + default: *678 '403': *29 '401': *25 x-github: @@ -104437,9 +104223,9 @@ paths: application/json: schema: type: array - items: *670 + items: *669 examples: - default: *695 + default: *694 headers: Link: *54 x-github: @@ -104543,7 +104329,7 @@ paths: application/json: schema: *22 examples: - default: *518 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104667,7 +104453,7 @@ paths: - docker - nuget - container - - *678 + - *677 - *59 - *19 - *17 @@ -104678,12 +104464,12 @@ paths: application/json: schema: type: array - items: *234 + items: *235 examples: - default: *679 + default: *678 '403': *29 '401': *25 - '400': *680 + '400': *679 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104703,17 +104489,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 responses: '200': description: Response content: application/json: - schema: *234 + schema: *235 examples: - default: *696 + default: *695 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104734,8 +104520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 responses: '204': @@ -104768,8 +104554,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *236 - *237 + - *238 - *59 - name: token description: package token @@ -104802,8 +104588,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: - - *236 - *237 + - *238 - *59 responses: '200': @@ -104812,7 +104598,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -104870,16 +104656,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *236 - *237 - - *239 + - *238 + - *240 - *59 responses: '200': description: Response content: application/json: - schema: *238 + schema: *239 examples: default: value: @@ -104914,10 +104700,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *236 - *237 + - *238 - *59 - - *239 + - *240 responses: '204': description: Response @@ -104949,10 +104735,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *236 - *237 + - *238 - *59 - - *239 + - *240 responses: '204': description: Response @@ -104964,87 +104750,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: - - *59 - - 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: *250 - 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: *54 - '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 @@ -105143,7 +104848,7 @@ paths: type: array items: *254 examples: - default: *697 + default: *696 headers: Link: *54 '304': *37 @@ -105166,7 +104871,7 @@ paths: url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - *253 - - *698 + - *697 - *59 responses: '200': @@ -105175,7 +104880,7 @@ paths: application/json: schema: *254 examples: - default: *699 + default: *698 headers: Link: *54 '304': *37 @@ -105292,7 +104997,7 @@ paths: description: Response content: application/json: - schema: *700 + schema: *699 examples: issue: *259 pull_request: *259 @@ -105678,9 +105383,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -105710,9 +105415,9 @@ paths: description: Response content: application/json: - schema: *701 + schema: *700 examples: - default: *702 + default: *701 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105740,9 +105445,9 @@ paths: description: Response content: application/json: - schema: *703 + schema: *702 examples: - default: *704 + default: *703 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105763,11 +105468,11 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *59 - - *105 - - *107 - *106 - - *705 - *108 + - *107 + - *704 + - *109 responses: '200': description: Response when getting a billing premium request usage report @@ -105903,9 +105608,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *705 examples: - default: *707 + default: *706 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105926,9 +105631,9 @@ paths: url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *59 - - *105 - - *708 - *106 + - *707 + - *107 responses: '200': description: Response when getting a billing usage report @@ -106007,7 +105712,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. @@ -106020,18 +105725,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: - *59 - - *105 - - *107 - *106 - - *709 - *108 - - *710 + - *107 + - *708 + - *109 + - *709 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -106162,9 +105867,9 @@ paths: application/json: schema: type: array - items: *683 + items: *682 examples: - default: *684 + default: *683 headers: Link: *54 x-github: @@ -106194,9 +105899,9 @@ paths: application/json: schema: type: array - items: *685 + items: *684 examples: - default: *711 + default: *710 headers: Link: *54 x-github: @@ -106221,7 +105926,7 @@ paths: url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - *59 - - *712 + - *711 - *48 - *17 - *19 @@ -106233,11 +105938,11 @@ paths: schema: anyOf: - type: array - items: *713 + items: *712 - type: array items: *66 examples: - default-response: *688 + default-response: *687 headers: Link: *54 x-github: @@ -106266,9 +105971,9 @@ paths: application/json: schema: type: array - items: *142 + items: *143 examples: - default: *240 + default: *241 headers: Link: *54 x-github: @@ -106396,7 +106101,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &714 + enterprise: &713 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106454,7 +106159,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &715 + installation: &714 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106473,7 +106178,7 @@ x-webhooks: required: - id - node_id - organization: &716 + organization: &715 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106533,13 +106238,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &717 + repository: &716 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &747 + properties: &746 id: description: Unique identifier of the repository example: 42 @@ -107222,7 +106927,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &748 + required: &747 - archive_url - assignees_url - blobs_url @@ -107373,10 +107078,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -107452,11 +107157,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: &718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: &717 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) @@ -107679,11 +107384,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: *717 sender: *4 required: - action @@ -107866,11 +107571,11 @@ x-webhooks: - everyone required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - rule: *718 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + rule: *717 sender: *4 required: - action @@ -107954,7 +107659,7 @@ x-webhooks: type: string enum: - completed - check_run: &720 + check_run: &719 title: CheckRun description: A check performed on the code of a given code change type: object @@ -108007,8 +107712,8 @@ x-webhooks: type: string pull_requests: type: array - items: *405 - repository: *142 + items: *403 + repository: *143 status: example: completed type: string @@ -108045,7 +107750,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *719 + deployment: *718 details_url: example: https://example.com type: string @@ -108095,7 +107800,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *405 + items: *403 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -108130,10 +107835,10 @@ x-webhooks: - output - app - pull_requests - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -108526,11 +108231,11 @@ x-webhooks: type: string enum: - created - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -108926,11 +108631,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 requested_action: description: The action requested by the user. type: object @@ -109335,11 +109040,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *720 - installation: *715 - enterprise: *714 - organization: *716 - repository: *717 + check_run: *719 + installation: *714 + enterprise: *713 + organization: *715 + repository: *716 sender: *4 required: - check_run @@ -110316,10 +110021,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -110989,10 +110694,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -111656,10 +111361,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -111825,7 +111530,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -111970,20 +111675,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &721 + commit_oid: &720 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: *714 - installation: *715 - organization: *716 - ref: &722 + enterprise: *713 + installation: *714 + organization: *715 + ref: &721 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: *717 + repository: *716 sender: *4 required: - action @@ -112148,7 +111853,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112378,12 +112083,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -112478,7 +112183,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -112649,12 +112354,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -112820,7 +112525,7 @@ x-webhooks: required: - login - id - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -112986,12 +112691,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -113091,7 +112796,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113259,16 +112964,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *717 + repository: *716 sender: *4 required: - action @@ -113365,7 +113070,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *421 + dismissed_comment: *419 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113505,12 +113210,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *721 - enterprise: *714 - installation: *715 - organization: *716 - ref: *722 - repository: *717 + commit_oid: *720 + enterprise: *713 + installation: *714 + organization: *715 + ref: *721 + repository: *716 sender: *4 required: - action @@ -113767,10 +113472,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -113850,18 +113555,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *716 - pusher_type: &723 + organization: *715 + pusher_type: &722 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &724 + ref: &723 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -113871,7 +113576,7 @@ x-webhooks: enum: - tag - branch - repository: *717 + repository: *716 sender: *4 required: - ref @@ -113954,9 +113659,9 @@ x-webhooks: enum: - created definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114041,9 +113746,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114121,9 +113826,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114201,9 +113906,9 @@ x-webhooks: enum: - updated definition: *263 - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -114280,10 +113985,10 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - repository: *717 - organization: *716 + enterprise: *713 + installation: *714 + repository: *716 + organization: *715 sender: *4 new_property_values: type: array @@ -114368,18 +114073,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - pusher_type: *723 - ref: *724 + enterprise: *713 + installation: *714 + organization: *715 + pusher_type: *722 + ref: *723 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *717 + repository: *716 sender: *4 required: - ref @@ -114463,11 +114168,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114551,11 +114256,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114639,11 +114344,11 @@ x-webhooks: type: string enum: - created - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114725,11 +114430,11 @@ x-webhooks: type: string enum: - dismissed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114811,11 +114516,11 @@ x-webhooks: type: string enum: - fixed - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114898,11 +114603,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -114984,11 +114689,11 @@ x-webhooks: type: string enum: - reopened - alert: *477 - installation: *715 - organization: *716 - enterprise: *714 - repository: *717 + alert: *475 + installation: *714 + organization: *715 + enterprise: *713 + repository: *716 sender: *4 required: - action @@ -115065,9 +114770,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - key: &725 + enterprise: *713 + installation: *714 + key: &724 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -115103,8 +114808,8 @@ x-webhooks: - verified - created_at - read_only - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -115181,11 +114886,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - key: *725 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + key: *724 + organization: *715 + repository: *716 sender: *4 required: - action @@ -115746,12 +115451,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: &729 + workflow: &728 title: Workflow type: object nullable: true @@ -116477,13 +116182,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *483 + deployment: *481 pull_requests: type: array - items: *569 - repository: *717 - organization: *716 - installation: *715 + items: *568 + repository: *716 + organization: *715 + installation: *714 sender: *4 responses: '200': @@ -116554,7 +116259,7 @@ x-webhooks: type: string enum: - approved - approver: &726 + approver: &725 type: object properties: avatar_url: @@ -116597,11 +116302,11 @@ x-webhooks: type: string comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: &727 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + reviewers: &726 type: array items: type: object @@ -116680,7 +116385,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &728 + workflow_job_run: &727 type: object properties: conclusion: @@ -117411,18 +117116,18 @@ x-webhooks: type: string enum: - rejected - approver: *726 + approver: *725 comment: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - reviewers: *727 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + reviewers: *726 sender: *4 since: type: string - workflow_job_run: *728 + workflow_job_run: *727 workflow_job_runs: type: array items: @@ -118126,13 +117831,13 @@ x-webhooks: type: string enum: - requested - enterprise: *714 + enterprise: *713 environment: type: string - installation: *715 - organization: *716 - repository: *717 - requestor: &734 + installation: *714 + organization: *715 + repository: *716 + requestor: &733 title: User type: object nullable: true @@ -120031,12 +119736,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Deployment Workflow Run type: object @@ -120716,7 +120421,7 @@ x-webhooks: type: string enum: - answered - answer: &732 + answer: &731 type: object properties: author_association: @@ -120873,7 +120578,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &730 + discussion: &729 title: Discussion description: A Discussion in a repository. type: object @@ -121159,7 +120864,7 @@ x-webhooks: - id labels: type: array - items: *531 + items: *530 required: - repository_url - category @@ -121181,10 +120886,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121311,11 +121016,11 @@ x-webhooks: - from required: - category - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121398,11 +121103,11 @@ x-webhooks: type: string enum: - closed - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121484,7 +121189,7 @@ x-webhooks: type: string enum: - created - comment: &731 + comment: &730 type: object properties: author_association: @@ -121641,11 +121346,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121728,12 +121433,12 @@ x-webhooks: type: string enum: - deleted - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *730 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121828,12 +121533,12 @@ x-webhooks: - from required: - body - comment: *731 - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + comment: *730 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -121917,11 +121622,11 @@ x-webhooks: type: string enum: - created - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122003,11 +121708,11 @@ x-webhooks: type: string enum: - deleted - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122107,11 +121812,11 @@ x-webhooks: type: string required: - from - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122193,10 +121898,10 @@ x-webhooks: type: string enum: - labeled - discussion: *730 - enterprise: *714 - installation: *715 - label: &733 + discussion: *729 + enterprise: *713 + installation: *714 + label: &732 title: Label type: object properties: @@ -122228,8 +121933,8 @@ x-webhooks: - color - default - description - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122312,11 +122017,11 @@ x-webhooks: type: string enum: - locked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122398,11 +122103,11 @@ x-webhooks: type: string enum: - pinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122484,11 +122189,11 @@ x-webhooks: type: string enum: - reopened - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122573,16 +122278,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *730 - new_repository: *717 + new_discussion: *729 + new_repository: *716 required: - new_discussion - new_repository - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122665,10 +122370,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *730 - old_answer: *732 - organization: *716 - repository: *717 + discussion: *729 + old_answer: *731 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122750,12 +122455,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *730 - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122838,11 +122543,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -122924,11 +122629,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *730 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + discussion: *729 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -123001,7 +122706,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *714 + enterprise: *713 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -123661,9 +123366,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - forkee @@ -123809,9 +123514,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pages: description: The pages that were updated. type: array @@ -123848,7 +123553,7 @@ x-webhooks: - action - sha - html_url - repository: *717 + repository: *716 sender: *4 required: - pages @@ -123924,10 +123629,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: &735 + organization: *715 + repositories: &734 description: An array of repository objects that the installation can access. type: array @@ -123953,8 +123658,8 @@ x-webhooks: - name - full_name - private - repository: *717 - requester: *734 + repository: *716 + requester: *733 sender: *4 required: - action @@ -124029,11 +123734,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124109,11 +123814,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124189,10 +123894,10 @@ x-webhooks: type: string enum: - added - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories_added: &736 + organization: *715 + repositories_added: &735 description: An array of repository objects, which were added to the installation. type: array @@ -124238,15 +123943,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *717 - repository_selection: &737 + repository: *716 + repository_selection: &736 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *734 + requester: *733 sender: *4 required: - action @@ -124325,10 +124030,10 @@ x-webhooks: type: string enum: - removed - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories_added: *736 + organization: *715 + repositories_added: *735 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -124355,9 +124060,9 @@ x-webhooks: - name - full_name - private - repository: *717 - repository_selection: *737 - requester: *734 + repository: *716 + repository_selection: *736 + requester: *733 sender: *4 required: - action @@ -124436,11 +124141,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124618,10 +124323,10 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 target_type: type: string @@ -124700,11 +124405,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *714 + enterprise: *713 installation: *22 - organization: *716 - repositories: *735 - repository: *717 + organization: *715 + repositories: *734 + repository: *716 requester: nullable: true sender: *4 @@ -124956,8 +124661,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -125751,8 +125456,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -125768,7 +125473,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -126101,8 +125806,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -126182,7 +125887,7 @@ x-webhooks: type: string enum: - deleted - comment: &738 + comment: &737 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -126347,8 +126052,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -127138,8 +126843,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -127155,7 +126860,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -127490,8 +127195,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -127571,7 +127276,7 @@ x-webhooks: type: string enum: - edited - changes: &767 + changes: &766 description: The changes to the comment. type: object properties: @@ -127583,9 +127288,9 @@ x-webhooks: type: string required: - from - comment: *738 - enterprise: *714 - installation: *715 + comment: *737 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128378,8 +128083,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128395,7 +128100,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -128728,8 +128433,8 @@ x-webhooks: - state - locked - assignee - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -128819,9 +128524,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -128915,9 +128620,9 @@ x-webhooks: type: number blocking_issue: *82 blocking_issue_repo: *66 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129010,9 +128715,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129106,9 +128811,9 @@ x-webhooks: description: The ID of the blocking issue. type: number blocking_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -129193,10 +128898,10 @@ x-webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - issue: &741 + assignee: *733 + enterprise: *713 + installation: *714 + issue: &740 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -129985,11 +129690,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -130005,7 +129710,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -130106,8 +129811,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -130187,8 +129892,8 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130982,11 +130687,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131002,7 +130707,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -131238,8 +130943,8 @@ x-webhooks: required: - state - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -131318,8 +131023,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132104,11 +131809,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132124,7 +131829,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -132224,8 +131929,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -132304,8 +132009,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -133112,11 +132817,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133132,7 +132837,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -133211,7 +132916,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &739 + milestone: &738 title: Milestone description: A collection of related issues and pull requests. type: object @@ -133349,8 +133054,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -133449,8 +133154,8 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134239,11 +133944,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -134256,7 +133961,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -134360,9 +134065,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -134442,8 +134147,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135231,11 +134936,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135248,7 +134953,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -135352,9 +135057,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *733 - organization: *716 - repository: *717 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -135434,8 +135139,8 @@ x-webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136247,11 +135952,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136264,7 +135969,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *216 + type: *217 title: description: Title of the issue type: string @@ -136345,8 +136050,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -136425,8 +136130,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +136937,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137252,7 +136957,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -137330,9 +137035,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *739 - organization: *716 - repository: *717 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -138200,11 +137905,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138297,7 +138002,7 @@ x-webhooks: required: - login - id - type: *216 + type: *217 required: - id - number @@ -138766,8 +138471,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139556,11 +139261,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139576,7 +139281,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -139676,8 +139381,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -139757,9 +139462,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *714 - installation: *715 - issue: &740 + enterprise: *713 + installation: *714 + issue: &739 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -140542,11 +140247,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140562,7 +140267,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -140662,8 +140367,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -140742,8 +140447,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -141553,11 +141258,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141651,9 +141356,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *216 - organization: *716 - repository: *717 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -142519,11 +142224,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142539,7 +142244,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -143107,11 +142812,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *714 - installation: *715 - issue: *740 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *739 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143191,12 +142896,12 @@ x-webhooks: type: string enum: - typed - enterprise: *714 - installation: *715 - issue: *741 - type: *216 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143277,7 +142982,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &770 + assignee: &769 title: User type: object nullable: true @@ -143347,11 +143052,11 @@ x-webhooks: required: - login - id - enterprise: *714 - installation: *715 - issue: *741 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143430,12 +143135,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - issue: *741 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -143515,8 +143220,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144326,11 +144031,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *647 - issue_dependencies_summary: *648 + sub_issues_summary: *646 + issue_dependencies_summary: *647 issue_field_values: type: array - items: *649 + items: *648 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144346,7 +144051,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *216 + type: *217 updated_at: type: string format: date-time @@ -144424,8 +144129,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144505,11 +144210,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *714 - installation: *715 - issue: *740 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *739 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144588,12 +144293,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *714 - installation: *715 - issue: *741 - type: *216 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + issue: *740 + type: *217 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144673,11 +144378,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144755,11 +144460,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144869,11 +144574,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - label: *733 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + label: *732 + organization: *715 + repository: *716 sender: *4 required: - action @@ -144955,9 +144660,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: &742 + enterprise: *713 + installation: *714 + marketplace_purchase: &741 title: Marketplace Purchase type: object required: @@ -145040,8 +144745,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: &743 + organization: *715 + previous_marketplace_purchase: &742 title: Marketplace Purchase type: object properties: @@ -145121,7 +144826,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145201,10 +144906,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145287,7 +144992,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145369,10 +145074,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -145454,7 +145159,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *717 + repository: *716 sender: *4 required: - action @@ -145535,8 +145240,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 marketplace_purchase: title: Marketplace Purchase type: object @@ -145618,9 +145323,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + organization: *715 + previous_marketplace_purchase: *742 + repository: *716 sender: *4 required: - action @@ -145700,12 +145405,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *714 - installation: *715 - marketplace_purchase: *742 - organization: *716 - previous_marketplace_purchase: *743 - repository: *717 + enterprise: *713 + installation: *714 + marketplace_purchase: *741 + organization: *715 + previous_marketplace_purchase: *742 + repository: *716 sender: *4 required: - action @@ -145807,11 +145512,11 @@ x-webhooks: type: string required: - to - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -145911,11 +145616,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -145994,11 +145699,11 @@ x-webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146076,11 +145781,11 @@ x-webhooks: type: string enum: - added - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146156,7 +145861,7 @@ x-webhooks: required: - login - id - team: &744 + team: &743 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -146379,11 +146084,11 @@ x-webhooks: type: string enum: - removed - enterprise: *714 - installation: *715 - member: *734 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + member: *733 + organization: *715 + repository: *716 scope: description: The scope of the membership. Currently, can only be `team`. @@ -146460,7 +146165,7 @@ x-webhooks: required: - login - id - team: *744 + team: *743 required: - action - scope @@ -146542,8 +146247,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *715 - merge_group: &746 + installation: *714 + merge_group: &745 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -146562,15 +146267,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *745 + head_commit: *744 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146656,10 +146361,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *715 - merge_group: *746 - organization: *716 - repository: *717 + installation: *714 + merge_group: *745 + organization: *715 + repository: *716 sender: *4 required: - action @@ -146732,7 +146437,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 + enterprise: *713 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -146841,16 +146546,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *715 - organization: *716 + installation: *714 + organization: *715 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -146931,11 +146636,11 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147014,9 +146719,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - milestone: &749 + enterprise: *713 + installation: *714 + milestone: &748 title: Milestone description: A collection of related issues and pull requests. type: object @@ -147153,8 +146858,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147233,11 +146938,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147347,11 +147052,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - milestone: *739 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *738 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147431,11 +147136,11 @@ x-webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - milestone: *749 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + milestone: *748 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147514,11 +147219,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *733 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147597,11 +147302,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *734 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + blocked_user: *733 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147680,9 +147385,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - membership: &750 + enterprise: *713 + installation: *714 + membership: &749 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -147789,8 +147494,8 @@ x-webhooks: - role - organization_url - user - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147868,11 +147573,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -147951,8 +147656,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -148068,10 +147773,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 - user: *734 + user: *733 required: - action - invitation @@ -148149,11 +147854,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -148240,11 +147945,11 @@ x-webhooks: properties: from: type: string - enterprise: *714 - installation: *715 - membership: *750 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + membership: *749 + organization: *715 + repository: *716 sender: *4 required: - action @@ -148320,9 +148025,9 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 package: description: Information about the package. type: object @@ -148821,7 +148526,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &751 + items: &750 title: Ruby Gems metadata type: object properties: @@ -148916,7 +148621,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -148992,9 +148697,9 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 package: description: Information about the package. type: object @@ -149347,7 +149052,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *751 + items: *750 source_url: type: string format: uri @@ -149417,7 +149122,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -149594,12 +149299,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *714 + enterprise: *713 id: type: integer - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - id @@ -149676,7 +149381,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &752 + personal_access_token_request: &751 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -149822,10 +149527,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *714 - organization: *716 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -149902,11 +149607,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *752 - enterprise: *714 - organization: *716 + personal_access_token_request: *751 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -149982,11 +149687,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *752 - enterprise: *714 - organization: *716 + personal_access_token_request: *751 + enterprise: *713 + organization: *715 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -150061,11 +149766,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *752 - organization: *716 - enterprise: *714 + personal_access_token_request: *751 + organization: *715 + enterprise: *713 sender: *4 - installation: *715 + installation: *714 required: - action - personal_access_token_request @@ -150170,7 +149875,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *753 + last_response: *752 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -150202,8 +149907,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 zen: description: Random string of GitHub zen. @@ -150448,10 +150153,10 @@ x-webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: &754 + enterprise: *713 + installation: *714 + organization: *715 + project_card: &753 title: Project Card type: object properties: @@ -150570,7 +150275,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -150651,11 +150356,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_card: *754 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_card: *753 + repository: *716 sender: *4 required: - action @@ -150735,9 +150440,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 project_card: title: Project Card type: object @@ -150865,8 +150570,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -150960,11 +150665,11 @@ x-webhooks: - from required: - note - enterprise: *714 - installation: *715 - organization: *716 - project_card: *754 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_card: *753 + repository: *716 sender: *4 required: - action @@ -151058,9 +150763,9 @@ x-webhooks: - from required: - column_id - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 project_card: allOf: - title: Project Card @@ -151250,7 +150955,7 @@ x-webhooks: type: string required: - after_id - repository: *717 + repository: *716 sender: *4 required: - action @@ -151330,10 +151035,10 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - organization: *716 - project: &756 + enterprise: *713 + installation: *714 + organization: *715 + project: &755 title: Project type: object properties: @@ -151457,7 +151162,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -151537,10 +151242,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project_column: &755 + enterprise: *713 + installation: *714 + organization: *715 + project_column: &754 title: Project Column type: object properties: @@ -151579,7 +151284,7 @@ x-webhooks: - name - created_at - updated_at - repository: *717 + repository: *716 sender: *4 required: - action @@ -151658,18 +151363,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -151759,11 +151464,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 + repository: *716 sender: *4 required: - action @@ -151843,11 +151548,11 @@ x-webhooks: type: string enum: - moved - enterprise: *714 - installation: *715 - organization: *716 - project_column: *755 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project_column: *754 + repository: *716 sender: *4 required: - action @@ -151927,11 +151632,11 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152011,18 +151716,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - project: *756 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *747 - required: *748 + properties: *746 + required: *747 nullable: true sender: *4 required: @@ -152124,11 +151829,11 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152207,11 +151912,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - organization: *716 - project: *756 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + project: *755 + repository: *716 sender: *4 required: - action @@ -152292,8 +151997,8 @@ x-webhooks: type: string enum: - closed - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152375,8 +152080,8 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152458,8 +152163,8 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152577,8 +152282,8 @@ x-webhooks: type: string to: type: string - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -152662,7 +152367,7 @@ x-webhooks: type: string enum: - archived - changes: &760 + changes: &759 type: object properties: archived_at: @@ -152676,9 +152381,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *715 - organization: *716 - projects_v2_item: &757 + installation: *714 + organization: *715 + projects_v2_item: &756 title: Projects v2 Item description: An item belonging to a project type: object @@ -152813,9 +152518,9 @@ x-webhooks: nullable: true to: type: string - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -152897,9 +152602,9 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -152980,9 +152685,9 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153088,7 +152793,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &758 + - &757 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -153110,7 +152815,7 @@ x-webhooks: required: - id - name - - &759 + - &758 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -153144,8 +152849,8 @@ x-webhooks: oneOf: - type: string - type: integer + - *757 - *758 - - *759 required: - field_value - type: object @@ -153161,9 +152866,9 @@ x-webhooks: nullable: true required: - body - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153258,9 +152963,9 @@ x-webhooks: to: type: string nullable: true - installation: *715 - organization: *716 - projects_v2_item: *757 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153343,10 +153048,10 @@ x-webhooks: type: string enum: - restored - changes: *760 - installation: *715 - organization: *716 - projects_v2_item: *757 + changes: *759 + installation: *714 + organization: *715 + projects_v2_item: *756 sender: *4 required: - action @@ -153428,8 +153133,8 @@ x-webhooks: type: string enum: - reopened - installation: *715 - organization: *716 + installation: *714 + organization: *715 projects_v2: *251 sender: *4 required: @@ -153511,14 +153216,14 @@ x-webhooks: type: string enum: - created - installation: *715 - organization: *716 - projects_v2_status_update: &763 + installation: *714 + organization: *715 + projects_v2_status_update: &762 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *761 - required: *762 + properties: *760 + required: *761 sender: *4 required: - action @@ -153599,9 +153304,9 @@ x-webhooks: type: string enum: - deleted - installation: *715 - organization: *716 - projects_v2_status_update: *763 + installation: *714 + organization: *715 + projects_v2_status_update: *762 sender: *4 required: - action @@ -153737,9 +153442,9 @@ x-webhooks: type: string format: date nullable: true - installation: *715 - organization: *716 - projects_v2_status_update: *763 + installation: *714 + organization: *715 + projects_v2_status_update: *762 sender: *4 required: - action @@ -153810,10 +153515,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - repository @@ -153890,13 +153595,13 @@ x-webhooks: type: string enum: - assigned - assignee: *734 - enterprise: *714 - installation: *715 - number: &764 + assignee: *733 + enterprise: *713 + installation: *714 + number: &763 description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -156179,7 +155884,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -156261,11 +155966,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -158543,7 +158248,7 @@ x-webhooks: - draft reason: type: string - repository: *717 + repository: *716 sender: *4 required: - action @@ -158625,11 +158330,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -160907,7 +160612,7 @@ x-webhooks: - draft reason: type: string - repository: *717 + repository: *716 sender: *4 required: - action @@ -160989,13 +160694,13 @@ x-webhooks: type: string enum: - closed - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: &765 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: &764 allOf: - - *569 + - *568 - type: object properties: allow_auto_merge: @@ -161057,7 +160762,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *717 + repository: *716 sender: *4 required: - action @@ -161138,12 +160843,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -161223,11 +160928,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *714 - milestone: *551 - number: *764 - organization: *716 - pull_request: &766 + enterprise: *713 + milestone: *550 + number: *763 + organization: *715 + pull_request: &765 title: Pull Request type: object properties: @@ -163490,7 +163195,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -163569,11 +163274,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -165855,7 +165560,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *717 + repository: *716 sender: *4 required: - action @@ -165979,12 +165684,12 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -166064,11 +165769,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -168335,7 +168040,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -168415,11 +168120,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *714 - installation: *715 - label: *733 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + label: *732 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -170701,7 +170406,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -170782,10 +170487,10 @@ x-webhooks: type: string enum: - locked - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -173065,7 +172770,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -173145,12 +172850,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *714 - milestone: *551 - number: *764 - organization: *716 - pull_request: *766 - repository: *717 + enterprise: *713 + milestone: *550 + number: *763 + organization: *715 + pull_request: *765 + repository: *716 sender: *4 required: - action @@ -173229,12 +172934,12 @@ x-webhooks: type: string enum: - opened - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173315,12 +173020,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173400,12 +173105,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *714 - installation: *715 - number: *764 - organization: *716 - pull_request: *765 - repository: *717 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 + pull_request: *764 + repository: *716 sender: *4 required: - action @@ -173771,9 +173476,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -175943,7 +175648,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -176023,7 +175728,7 @@ x-webhooks: type: string enum: - deleted - comment: &768 + comment: &767 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -176308,9 +176013,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -178468,7 +178173,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -178548,11 +178253,11 @@ x-webhooks: type: string enum: - edited - changes: *767 - comment: *768 - enterprise: *714 - installation: *715 - organization: *716 + changes: *766 + comment: *767 + enterprise: *713 + installation: *714 + organization: *715 pull_request: type: object properties: @@ -180713,7 +180418,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *717 + repository: *716 sender: *4 required: - action @@ -180794,9 +180499,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -182969,7 +182674,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 review: description: The review that was affected. type: object @@ -183216,9 +182921,9 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -185272,8 +184977,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: &769 + repository: *716 + review: &768 description: The review that was affected. type: object properties: @@ -185506,12 +185211,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -187794,7 +187499,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_reviewer: title: User type: object @@ -187878,12 +187583,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -190173,7 +189878,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190365,12 +190070,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -192655,7 +192360,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_reviewer: title: User type: object @@ -192740,12 +192445,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *714 - installation: *715 + enterprise: *713 + installation: *714 number: description: The pull request number. type: integer - organization: *716 + organization: *715 pull_request: title: Pull Request type: object @@ -195021,7 +194726,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195202,9 +194907,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -197379,8 +197084,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 - review: *769 + repository: *716 + review: *768 sender: *4 required: - action @@ -197460,9 +197165,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -199532,7 +199237,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 sender: *4 thread: type: object @@ -199919,9 +199624,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 pull_request: title: Simple Pull Request type: object @@ -201977,7 +201682,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *717 + repository: *716 sender: *4 thread: type: object @@ -202367,10 +202072,10 @@ x-webhooks: type: string before: type: string - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -204641,7 +204346,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -204723,11 +204428,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *770 - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + assignee: *769 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -207010,7 +206715,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -207089,11 +206794,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *714 - installation: *715 - label: *733 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + label: *732 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -209366,7 +209071,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -209447,10 +209152,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *714 - installation: *715 - number: *764 - organization: *716 + enterprise: *713 + installation: *714 + number: *763 + organization: *715 pull_request: title: Pull Request type: object @@ -211715,7 +211420,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *717 + repository: *716 sender: *4 required: - action @@ -211915,7 +211620,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *714 + enterprise: *713 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212007,8 +211712,8 @@ x-webhooks: - url - author - committer - installation: *715 - organization: *716 + installation: *714 + organization: *715 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212583,9 +212288,9 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 registry_package: type: object properties: @@ -213031,7 +212736,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *751 + items: *750 summary: type: string tag_name: @@ -213085,7 +212790,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -213163,9 +212868,9 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 registry_package: type: object properties: @@ -213473,7 +213178,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *751 + items: *750 summary: type: string tag_name: @@ -213522,7 +213227,7 @@ x-webhooks: - owner - package_version - registry - repository: *717 + repository: *716 sender: *4 required: - action @@ -213599,10 +213304,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - release: &771 + enterprise: *713 + installation: *714 + organization: *715 + release: &770 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -213920,7 +213625,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *717 + repository: *716 sender: *4 required: - action @@ -213997,11 +213702,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -214118,11 +213823,11 @@ x-webhooks: type: boolean required: - to - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -214200,9 +213905,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -214524,7 +214229,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *717 + repository: *716 sender: *4 required: - action @@ -214600,10 +214305,10 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - release: &772 + enterprise: *713 + installation: *714 + organization: *715 + release: &771 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -214922,7 +214627,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *717 + repository: *716 sender: *4 required: - action @@ -214998,11 +214703,11 @@ x-webhooks: type: string enum: - released - enterprise: *714 - installation: *715 - organization: *716 - release: *771 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *770 + repository: *716 sender: *4 required: - action @@ -215078,11 +214783,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *714 - installation: *715 - organization: *716 - release: *772 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + release: *771 + repository: *716 sender: *4 required: - action @@ -215158,11 +214863,11 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *633 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + repository_advisory: *632 sender: *4 required: - action @@ -215238,11 +214943,11 @@ x-webhooks: type: string enum: - reported - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - repository_advisory: *633 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + repository_advisory: *632 sender: *4 required: - action @@ -215318,10 +215023,10 @@ x-webhooks: type: string enum: - archived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215398,10 +215103,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215479,10 +215184,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215566,10 +215271,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215681,10 +215386,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215756,10 +215461,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 status: type: string @@ -215840,10 +215545,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -215920,10 +215625,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216017,10 +215722,10 @@ x-webhooks: - name required: - repository - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216100,10 +215805,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 sender: *4 required: @@ -216182,10 +215887,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 sender: *4 required: @@ -216264,10 +215969,10 @@ x-webhooks: type: string enum: - edited - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 repository_ruleset: *295 changes: type: object @@ -216329,16 +216034,16 @@ x-webhooks: properties: added: type: array - items: *590 + items: *589 deleted: type: array - items: *590 + items: *589 updated: type: array items: type: object properties: - rule: *590 + rule: *589 changes: type: object properties: @@ -216572,10 +216277,10 @@ x-webhooks: - from required: - owner - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216653,10 +216358,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -216734,7 +216439,7 @@ x-webhooks: type: string enum: - create - alert: &773 + alert: &772 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -216855,10 +216560,10 @@ x-webhooks: type: string enum: - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217064,10 +216769,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217145,11 +216850,11 @@ x-webhooks: type: string enum: - reopen - alert: *773 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *772 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217348,10 +217053,10 @@ x-webhooks: enum: - fixed - open - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217429,11 +217134,11 @@ x-webhooks: type: string enum: - created - alert: &774 + alert: &773 type: object properties: - number: *158 - created_at: *159 + number: *159 + created_at: *160 updated_at: type: string description: 'The time that the alert was last updated in ISO @@ -217441,8 +217146,8 @@ x-webhooks: format: date-time readOnly: true nullable: true - url: *161 - html_url: *162 + url: *162 + html_url: *163 locations_url: type: string format: uri @@ -217547,10 +217252,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217631,11 +217336,11 @@ x-webhooks: type: string enum: - created - alert: *774 - installation: *715 - location: *775 - organization: *716 - repository: *717 + alert: *773 + installation: *714 + location: *774 + organization: *715 + repository: *716 sender: *4 required: - location @@ -217873,11 +217578,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -217955,11 +217660,11 @@ x-webhooks: type: string enum: - reopened - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218037,11 +217742,11 @@ x-webhooks: type: string enum: - resolved - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218119,11 +217824,11 @@ x-webhooks: type: string enum: - validated - alert: *774 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + alert: *773 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -218249,10 +217954,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *717 - enterprise: *714 - installation: *715 - organization: *716 + repository: *716 + enterprise: *713 + installation: *714 + organization: *715 sender: *4 required: - action @@ -218330,11 +218035,11 @@ x-webhooks: type: string enum: - published - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: &776 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + security_advisory: &775 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218517,11 +218222,11 @@ x-webhooks: type: string enum: - updated - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 - security_advisory: *776 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 + security_advisory: *775 sender: *4 required: - action @@ -218594,10 +218299,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218782,10 +218487,10 @@ x-webhooks: type: object properties: security_and_analysis: *269 - enterprise: *714 - installation: *715 - organization: *716 - repository: *332 + enterprise: *713 + installation: *714 + organization: *715 + repository: *330 sender: *4 required: - changes @@ -218863,12 +218568,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: &777 + sponsorship: &776 type: object properties: created_at: @@ -219169,12 +218874,12 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - sponsorship @@ -219262,12 +218967,12 @@ x-webhooks: type: string required: - from - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219344,17 +219049,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &778 + effective_date: &777 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: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - sponsorship @@ -219428,7 +219133,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &779 + changes: &778 type: object properties: tier: @@ -219472,13 +219177,13 @@ x-webhooks: - from required: - tier - effective_date: *778 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + effective_date: *777 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219555,13 +219260,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *779 - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + changes: *778 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - sponsorship: *777 + sponsorship: *776 required: - action - changes @@ -219635,10 +219340,10 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219721,10 +219426,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220144,15 +219849,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *714 + enterprise: *713 id: description: The unique identifier of the status. type: integer - installation: *715 + installation: *714 name: type: string - organization: *716 - repository: *717 + organization: *715 + repository: *716 sender: *4 sha: description: The Commit SHA. @@ -220267,9 +219972,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220359,9 +220064,9 @@ x-webhooks: description: The ID of the sub-issue. type: number sub_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220451,9 +220156,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220543,9 +220248,9 @@ x-webhooks: description: The ID of the parent issue. type: number parent_issue: *82 - installation: *715 - organization: *716 - repository: *717 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -220622,12 +220327,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - team: &780 + team: &779 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220850,9 +220555,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -221310,7 +221015,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -221386,9 +221091,9 @@ x-webhooks: type: string enum: - created - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -221846,7 +221551,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -221923,9 +221628,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -222383,7 +222088,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -222527,9 +222232,9 @@ x-webhooks: - from required: - permissions - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -222987,7 +222692,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - changes @@ -223065,9 +222770,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *714 - installation: *715 - organization: *716 + enterprise: *713 + installation: *714 + organization: *715 repository: title: Repository description: A git repository @@ -223525,7 +223230,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *780 + team: *779 required: - action - team @@ -223601,10 +223306,10 @@ x-webhooks: type: string enum: - started - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 required: - action @@ -223677,16 +223382,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *714 + enterprise: *713 inputs: type: object nullable: true additionalProperties: true - installation: *715 - organization: *716 + installation: *714 + organization: *715 ref: type: string - repository: *717 + repository: *716 sender: *4 workflow: type: string @@ -223768,10 +223473,10 @@ x-webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: allOf: @@ -224008,7 +223713,7 @@ x-webhooks: type: string required: - conclusion - deployment: *483 + deployment: *481 required: - action - repository @@ -224087,10 +223792,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: allOf: @@ -224350,7 +224055,7 @@ x-webhooks: required: - status - steps - deployment: *483 + deployment: *481 required: - action - repository @@ -224429,10 +224134,10 @@ x-webhooks: type: string enum: - queued - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: type: object @@ -224567,7 +224272,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *483 + deployment: *481 required: - action - repository @@ -224646,10 +224351,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 workflow_job: type: object @@ -224785,7 +224490,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *483 + deployment: *481 required: - action - repository @@ -224865,12 +224570,12 @@ x-webhooks: type: string enum: - completed - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object @@ -225869,12 +225574,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object @@ -226858,12 +226563,12 @@ x-webhooks: type: string enum: - requested - enterprise: *714 - installation: *715 - organization: *716 - repository: *717 + enterprise: *713 + installation: *714 + organization: *715 + repository: *716 sender: *4 - workflow: *729 + workflow: *728 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 902af3878..a8e033fd7 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -61502,6 +61502,1753 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -64193,7 +65940,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" @@ -64201,7 +65948,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": [ { @@ -64288,7 +66035,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -96776,6 +98523,1264 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -97457,7 +100462,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" @@ -97465,7 +100470,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": [ { @@ -97534,7 +100539,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -179050,847 +182055,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -234497,965 +236661,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -464819,1245 +466024,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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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": { @@ -466079,21 +466116,94 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" @@ -466101,7 +466211,41 @@ "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -466116,12 +466260,112 @@ "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -523206,8 +523450,12 @@ "nullable": true } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -619796,416 +620044,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -650975,421 +650813,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", @@ -674565,7 +673988,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" @@ -674573,7 +673996,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": [ { @@ -674642,7 +674065,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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 9882bdc41..dad162cce 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -865,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &432 + type: &435 type: string description: The type of credit the user is receiving. enum: @@ -998,7 +998,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &256 + schema: &260 title: Validation Error Simple description: Validation Error Simple type: object @@ -1031,7 +1031,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &761 + - &763 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1149,7 +1149,7 @@ paths: GitHub. type: object nullable: true - properties: &211 + properties: &212 id: description: Unique identifier of the GitHub app example: 37 @@ -1282,7 +1282,7 @@ paths: about itself. example: 5 type: integer - required: &212 + required: &213 - id - node_id - owner @@ -1587,7 +1587,7 @@ paths: schema: type: integer default: 30 - - &342 + - &346 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1603,7 +1603,7 @@ paths: application/json: schema: type: array - items: &343 + items: &347 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1683,7 +1683,7 @@ paths: - installation_id - repository_id examples: - default: &344 + default: &348 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1715,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &771 + schema: &773 title: Scim Error description: Scim Error type: object @@ -1742,7 +1742,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &255 + schema: &259 title: Validation Error description: Validation Error type: object @@ -1811,7 +1811,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &349 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1925,7 +1925,7 @@ paths: - request - response examples: - default: &346 + default: &350 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2126,7 +2126,7 @@ paths: parameters: - *17 - *19 - - &216 + - &217 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) @@ -2892,7 +2892,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &410 + properties: &413 id: description: Unique identifier of the repository example: 42 @@ -2912,7 +2912,7 @@ paths: title: License Simple description: License Simple type: object - properties: &227 + properties: &228 key: type: string example: mit @@ -2934,7 +2934,7 @@ paths: html_url: type: string format: uri - required: &228 + required: &229 - key - name - url @@ -3330,7 +3330,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &411 + required: &414 - archive_url - assignees_url - blobs_url @@ -7487,7 +7487,7 @@ paths: description: Response content: application/json: - schema: &257 + schema: &261 type: object properties: total_active_caches_count: @@ -7502,7 +7502,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &258 + default: &262 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7695,7 +7695,7 @@ paths: - public_ip_enabled - platform examples: - default: &259 + default: &263 value: total_count: 2 runners: @@ -7990,7 +7990,7 @@ paths: application/json: schema: *45 examples: - default: &260 + default: &264 value: id: 1 platform: linux-x64 @@ -8130,7 +8130,7 @@ paths: application/json: schema: *48 examples: - default: &261 + default: &265 value: version: 1.0.0 size_gb: 75 @@ -8294,7 +8294,7 @@ paths: description: Response content: application/json: - schema: &262 + schema: &266 type: object properties: public_ips: @@ -8319,7 +8319,7 @@ paths: required: - public_ips examples: - default: &263 + default: &267 value: public_ips: current_usage: 17 @@ -8359,7 +8359,7 @@ paths: type: array items: *52 examples: - default: &264 + default: &268 value: id: 4-core cpu_cores: 4 @@ -8621,7 +8621,7 @@ paths: - all - local_only - selected - selected_actions_url: &267 + selected_actions_url: &271 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` @@ -8701,7 +8701,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &269 + schema: &273 type: object properties: days: @@ -8719,7 +8719,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &772 + '401': &774 description: Authorization failure '404': *6 x-github: @@ -8747,7 +8747,7 @@ paths: required: true content: application/json: - schema: &270 + schema: &274 type: object properties: days: @@ -8796,7 +8796,7 @@ paths: required: - approval_policy examples: - default: &271 + default: &275 value: approval_policy: first_time_contributors '404': *6 @@ -8854,7 +8854,7 @@ paths: description: Response content: application/json: - schema: &272 + schema: &276 type: object required: - run_workflows_from_fork_pull_requests @@ -8908,7 +8908,7 @@ paths: required: true content: application/json: - schema: &273 + schema: &277 type: object required: - run_workflows_from_fork_pull_requests @@ -9331,7 +9331,7 @@ paths: description: Success response content: application/json: - schema: &276 + schema: &280 type: object properties: default_workflow_permissions: &63 @@ -9379,7 +9379,7 @@ paths: required: true content: application/json: - schema: &277 + schema: &281 type: object properties: default_workflow_permissions: *63 @@ -10215,7 +10215,7 @@ paths: application/json: schema: type: array - items: &281 + items: &285 title: Runner Application description: Runner Application type: object @@ -10240,7 +10240,7 @@ paths: - download_url - filename examples: - default: &282 + default: &286 value: - os: osx architecture: x64 @@ -10324,7 +10324,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &283 + '201': &287 description: Response content: application/json: @@ -10439,7 +10439,7 @@ paths: - token - expires_at examples: - default: &284 + default: &288 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10479,7 +10479,7 @@ paths: application/json: schema: *75 examples: - default: &285 + default: &289 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10511,7 +10511,7 @@ paths: application/json: schema: *72 examples: - default: &286 + default: &290 value: id: 23 name: MBP @@ -10727,7 +10727,7 @@ paths: - *41 - *71 responses: - '200': &287 + '200': &291 description: Response content: application/json: @@ -10783,7 +10783,7 @@ paths: parameters: - *41 - *71 - - &288 + - &292 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10874,7 +10874,7 @@ paths: required: true content: application/json: - schema: &295 + schema: &299 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -11515,7 +11515,7 @@ paths: required: false schema: type: string - - &296 + - &300 name: include description: |- The event types to include: @@ -11533,7 +11533,7 @@ paths: - web - git - all - - &297 + - &301 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. @@ -11541,7 +11541,7 @@ paths: required: false schema: type: string - - &298 + - &302 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. @@ -11549,7 +11549,7 @@ paths: required: false schema: type: string - - &299 + - &303 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11571,7 +11571,7 @@ paths: application/json: schema: type: array - items: &300 + items: &304 type: object properties: "@timestamp": @@ -11693,7 +11693,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &301 + default: &305 value: - "@timestamp": 1606929874512 action: team.add_member @@ -12359,7 +12359,7 @@ paths: application/json: schema: type: array - items: &302 + items: &306 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12520,7 +12520,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &303 + default: &307 value: - id: 21 number: 42 @@ -12625,7 +12625,7 @@ paths: application/json: schema: type: array - items: &305 + items: &309 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12750,7 +12750,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &306 + default: &310 value: - id: 21 number: 42 @@ -12835,7 +12835,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &311 + - &315 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`, @@ -12845,7 +12845,7 @@ paths: schema: &107 type: string description: The name of the tool used to generate the code scanning analysis. - - &312 + - &316 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 @@ -12868,7 +12868,7 @@ paths: be returned. in: query required: false - schema: &313 + schema: &317 type: string description: State of a code scanning alert. enum: @@ -12893,7 +12893,7 @@ paths: application/json: schema: type: array - items: &314 + items: &318 type: object properties: number: &123 @@ -12922,7 +12922,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &547 + instances_url: &548 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12957,7 +12957,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &548 + dismissed_reason: &549 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12966,13 +12966,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &549 + dismissed_comment: &550 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &550 + rule: &551 type: object properties: id: @@ -13025,7 +13025,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &551 + tool: &552 type: object properties: name: *107 @@ -13035,15 +13035,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &552 + most_recent_instance: &553 type: object properties: - ref: &545 + ref: &546 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &562 + analysis_key: &563 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13054,7 +13054,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &563 + category: &564 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13103,7 +13103,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &244 + properties: &245 id: type: integer format: int64 @@ -13330,7 +13330,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &245 + required: &246 - archive_url - assignees_url - blobs_url @@ -13402,7 +13402,7 @@ paths: - most_recent_instance - repository examples: - default: &315 + default: &319 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -14055,7 +14055,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &316 + code_scanning_options: &320 type: object description: Security Configuration feature options for code scanning nullable: true @@ -14249,7 +14249,7 @@ paths: description: Response content: application/json: - schema: &318 + schema: &322 type: array description: A list of default code security configurations items: @@ -14265,7 +14265,7 @@ paths: default configuration: *110 examples: - default: &319 + default: &323 value: - default_for_new_repos: public configuration: @@ -14719,7 +14719,7 @@ paths: default: value: default_for_new_repos: all - configuration: &317 + configuration: &321 value: id: 1325 target_type: organization @@ -14804,7 +14804,7 @@ paths: application/json: schema: type: array - items: &320 + items: &324 type: object description: Repositories associated with a code security configuration and attachment status @@ -14828,7 +14828,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &321 + repository: &325 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15317,7 +15317,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &307 + - &311 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15392,7 +15392,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &377 + properties: &381 id: description: Unique identifier of the team type: integer @@ -15464,7 +15464,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &378 + required: &382 - id - node_id - url @@ -16052,7 +16052,7 @@ paths: application/json: schema: type: array - items: &201 + items: &202 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16359,7 +16359,7 @@ paths: - date additionalProperties: true examples: - default: &202 + default: &203 value: - date: '2024-06-24' total_active_users: 24 @@ -16461,7 +16461,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &203 + '422': &204 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16697,7 +16697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &327 + - &331 name: state in: query description: |- @@ -16706,7 +16706,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &328 + - &332 name: severity in: query description: |- @@ -16715,7 +16715,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &329 + - &333 name: ecosystem in: query description: |- @@ -16724,14 +16724,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &330 + - &334 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 - - &331 + - &335 name: epss_percentage in: query description: |- @@ -16743,7 +16743,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &602 + - &603 name: has in: query description: |- @@ -16757,7 +16757,7 @@ paths: type: string enum: - patch - - &332 + - &336 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16767,7 +16767,7 @@ paths: enum: - development - runtime - - &333 + - &337 name: sort in: query description: |- @@ -16793,7 +16793,7 @@ paths: application/json: schema: type: array - items: &334 + items: &338 type: object description: A Dependabot alert. properties: @@ -16856,7 +16856,7 @@ paths: - unknown - direct - transitive - security_advisory: &603 + security_advisory: &604 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17088,7 +17088,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &604 + auto_dismissed_at: &605 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -17114,7 +17114,7 @@ paths: - repository additionalProperties: false examples: - default: &335 + default: &339 value: - number: 2 state: dismissed @@ -17895,7 +17895,7 @@ paths: type: array items: *140 examples: - default: &204 + default: &205 value: - id: 1 name: Justice League @@ -18226,7 +18226,7 @@ paths: - name - created_on examples: - default: &443 + default: &446 value: total_count: 2 network_configurations: @@ -18449,7 +18449,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &444 + - &447 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18461,7 +18461,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &448 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18495,7 +18495,7 @@ paths: - subnet_id - region examples: - default: &446 + default: &449 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -19295,7 +19295,7 @@ paths: required: true content: application/json: - schema: &409 + schema: &412 title: Custom Property Set Payload description: Custom property set payload type: object @@ -20414,7 +20414,7 @@ paths: nullable: true anyOf: - *157 - - &415 + - &418 title: Organization ruleset conditions type: object description: |- @@ -20461,7 +20461,7 @@ paths: - *160 rules: type: array - items: &727 + items: &729 title: Repository Rule type: object description: A repository rule. @@ -20470,7 +20470,7 @@ paths: - *166 - *167 - *168 - - &724 + - &726 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20564,7 +20564,7 @@ paths: - *182 - *183 - *184 - - &725 + - &727 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -20820,7 +20820,7 @@ paths: type: string format: date-time examples: - default: &418 + default: &421 value: - version_id: 3 actor: @@ -20873,7 +20873,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &422 allOf: - *189 - type: object @@ -20928,7 +20928,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &420 + - &423 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -20939,7 +20939,7 @@ paths: enum: - open - resolved - - &421 + - &424 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -20949,7 +20949,7 @@ paths: required: false schema: type: string - - &422 + - &425 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -20958,7 +20958,7 @@ paths: required: false schema: type: string - - &423 + - &426 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. @@ -20974,7 +20974,7 @@ paths: - *17 - *104 - *105 - - &424 + - &427 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -20983,7 +20983,7 @@ paths: required: false schema: type: string - - &425 + - &428 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -20992,7 +20992,7 @@ paths: schema: type: boolean default: false - - &426 + - &429 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21001,7 +21001,7 @@ paths: schema: type: boolean default: false - - &427 + - &430 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21017,7 +21017,7 @@ paths: application/json: schema: type: array - items: &428 + items: &431 type: object properties: number: *123 @@ -21036,14 +21036,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &739 + state: &741 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: &740 + resolution: &742 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21150,8 +21150,8 @@ paths: pull request. ' - oneOf: &741 - - &743 + oneOf: &743 + - &745 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21203,7 +21203,7 @@ paths: - blob_url - commit_sha - commit_url - - &744 + - &746 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. @@ -21258,7 +21258,7 @@ paths: - page_url - commit_sha - commit_url - - &745 + - &747 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21272,7 +21272,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &746 + - &748 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21286,7 +21286,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &747 + - &749 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21300,7 +21300,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &748 + - &750 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21314,7 +21314,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &749 + - &751 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21328,7 +21328,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &750 + - &752 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21342,7 +21342,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &751 + - &753 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. @@ -21356,7 +21356,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &752 + - &754 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. @@ -21370,7 +21370,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &753 + - &755 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. @@ -21384,7 +21384,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &754 + - &756 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. @@ -21398,7 +21398,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &755 + - &757 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -21425,7 +21425,7 @@ paths: required: *21 nullable: true examples: - default: &429 + default: &432 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21634,7 +21634,7 @@ paths: description: Response content: application/json: - schema: &430 + schema: &433 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21717,7 +21717,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &431 + default: &434 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21861,7 +21861,7 @@ paths: description: Response content: application/json: - schema: &434 + schema: &437 type: object properties: total_minutes_used: @@ -21931,7 +21931,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &435 + default: &438 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -21962,7 +21962,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &436 + - &439 name: advanced_security_product in: query description: | @@ -21982,7 +21982,7 @@ paths: description: Success content: application/json: - schema: &437 + schema: &440 type: object properties: total_advanced_security_committers: @@ -22037,7 +22037,7 @@ paths: required: - repositories examples: - default: &438 + default: &441 value: total_advanced_security_committers: 2 total_count: 2 @@ -22064,6 +22064,698 @@ 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: + - *41 + responses: + '200': &247 + 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 + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - 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': *29 + 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: + - *41 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + example: 100.0 + minimum: 0.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - mona + - lisa + required: + - message + - budget + examples: + create-budget: + value: + message: Budget successfully created. + '400': *14 + '401': *25 + '403': *29 + '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: + - *41 + - &193 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': &248 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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': *29 + '500': *40 + '503': *190 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + example: 100.0 + minimum: 0.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - mona + - lisa + required: + - budget + - message + examples: + update-budget: + value: + message: Budget successfully updated. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + '400': *14 + '401': *25 + '403': *29 + '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: + - *41 + - *193 + responses: + '200': &249 + 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': *29 + '500': *40 + '503': *190 + 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 @@ -22286,7 +22978,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &195 + - &196 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22298,7 +22990,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &193 + schema: &194 type: object properties: id: @@ -22337,7 +23029,7 @@ paths: - name - resources examples: - default: &194 + default: &195 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -22401,9 +23093,9 @@ paths: description: Response when updating a cost center content: application/json: - schema: *193 + schema: *194 examples: - default: *194 + default: *195 '400': *14 '403': *29 '404': *6 @@ -22427,7 +23119,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *195 + - *196 responses: '200': description: Response when deleting a cost center @@ -22487,7 +23179,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *195 + - *196 requestBody: required: true content: @@ -22579,7 +23271,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *195 + - *196 requestBody: required: true content: @@ -22657,7 +23349,7 @@ paths: description: Response content: application/json: - schema: &439 + schema: &442 type: object properties: total_gigabytes_bandwidth_used: @@ -22675,7 +23367,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &440 + default: &443 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -22700,7 +23392,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &196 + - &197 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, @@ -22709,7 +23401,7 @@ paths: required: false schema: type: integer - - &198 + - &199 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 @@ -22718,7 +23410,7 @@ paths: required: false schema: type: integer - - &197 + - &198 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 @@ -22727,7 +23419,7 @@ paths: required: false schema: type: integer - - &199 + - &200 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -22735,21 +23427,21 @@ paths: required: false schema: type: string - - &246 + - &250 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &247 + - &251 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &200 + - &201 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -22919,7 +23611,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &444 type: object properties: days_left_in_billing_cycle: @@ -22937,7 +23629,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &442 + default: &445 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -22962,8 +23654,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *196 - - &248 + - *197 + - &252 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 @@ -22972,7 +23664,7 @@ paths: required: false schema: type: integer - - *197 + - *198 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -22985,7 +23677,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &249 + schema: &253 type: object properties: usageItems: @@ -23038,7 +23730,7 @@ paths: - netAmount - organizationName examples: - default: &250 + default: &254 value: usageItems: - date: '2023-08-01' @@ -23063,7 +23755,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. @@ -23076,22 +23768,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: - *41 - - *196 - - *198 - *197 - *199 - - &251 + - *198 + - *200 + - &255 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *200 - - &252 + - *201 + - &256 name: sku description: The SKU to query for usage. in: query @@ -23107,7 +23799,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: @@ -23290,13 +23982,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23325,7 +24017,7 @@ paths: type: array items: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -23402,7 +24094,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23420,7 +24112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &205 + - &206 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -23439,7 +24131,7 @@ paths: type: array items: *4 examples: - default: &206 + default: &207 value: - login: octocat id: 1 @@ -23478,7 +24170,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23509,7 +24201,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23527,7 +24219,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23558,7 +24250,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23576,7 +24268,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *205 + - *206 - *138 responses: '200': @@ -23585,7 +24277,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &207 + exampleKey1: &208 value: login: octocat id: 1 @@ -23621,7 +24313,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *205 + - *206 - *138 responses: '201': @@ -23630,7 +24322,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *207 + exampleKey1: *208 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23648,7 +24340,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *205 + - *206 - *138 responses: '204': @@ -23671,7 +24363,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *41 - - *205 + - *206 - *17 - *19 responses: @@ -23683,7 +24375,7 @@ paths: type: array items: *69 examples: - default: &208 + default: &209 value: login: github id: 1 @@ -23714,7 +24406,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23744,7 +24436,7 @@ paths: type: array items: *69 examples: - default: &243 + default: &244 value: - login: github id: 1 @@ -23775,7 +24467,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23816,7 +24508,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '200': @@ -23825,7 +24517,7 @@ paths: application/json: schema: *69 examples: - default: *208 + default: *209 '404': description: The team is not assigned to the organization x-github: @@ -23844,7 +24536,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '201': @@ -23853,7 +24545,7 @@ paths: application/json: schema: *69 examples: - default: *208 + default: *209 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23870,7 +24562,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '204': @@ -23895,7 +24587,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &209 + - &210 name: team_slug description: The slug of the team name. in: path @@ -23909,7 +24601,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -23929,7 +24621,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *209 + - *210 requestBody: required: true content: @@ -23986,7 +24678,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -24009,7 +24701,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *209 + - *210 responses: '204': description: Response @@ -24108,7 +24800,7 @@ paths: application/json: schema: type: array - items: &238 + items: &239 title: Event description: Event type: object @@ -24118,7 +24810,7 @@ paths: type: type: string nullable: true - actor: &210 + actor: &211 title: Actor description: Actor type: object @@ -24158,18 +24850,18 @@ paths: - id - name - url - org: *210 + org: *211 payload: type: object properties: action: type: string - issue: &226 + issue: &227 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &661 + properties: &663 id: type: integer format: int64 @@ -24281,7 +24973,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &401 + properties: &404 url: type: string format: uri @@ -24351,7 +25043,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &402 + required: &405 - closed_issues - creator - description @@ -24430,7 +25122,7 @@ paths: timeline_url: type: string format: uri - type: &364 + type: &368 title: Issue Type description: The type of issue. type: object @@ -24489,9 +25181,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - author_association: &213 + properties: *212 + required: *213 + author_association: &214 title: author_association type: string example: OWNER @@ -24505,7 +25197,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &214 + reactions: &215 title: Reaction Rollup type: object properties: @@ -24541,7 +25233,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &799 + sub_issues_summary: &801 title: Sub-issues Summary type: object properties: @@ -24561,7 +25253,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &800 + issue_dependencies_summary: &802 title: Issue Dependencies Summary type: object properties: @@ -24580,7 +25272,7 @@ paths: - total_blocking issue_field_values: type: array - items: &801 + items: &803 title: Issue Field Value description: A value assigned to an issue field type: object @@ -24640,7 +25332,7 @@ paths: - node_id - data_type - value - required: &662 + required: &664 - assignee - closed_at - comments @@ -24661,7 +25353,7 @@ paths: - user - created_at - updated_at - comment: &659 + comment: &661 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -24709,7 +25401,7 @@ paths: issue_url: type: string format: uri - author_association: *213 + author_association: *214 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -24719,9 +25411,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - id - node_id @@ -24888,7 +25580,7 @@ paths: _links: type: object properties: - timeline: &215 + timeline: &216 title: Link With Type description: Hypermedia Link with Type type: object @@ -24900,17 +25592,17 @@ paths: required: - href - type - user: *215 - security_advisories: *215 - current_user: *215 - current_user_public: *215 - current_user_actor: *215 - current_user_organization: *215 + user: *216 + security_advisories: *216 + current_user: *216 + current_user_public: *216 + current_user_actor: *216 + current_user_organization: *216 current_user_organizations: type: array - items: *215 - repository_discussions: *215 - repository_discussions_category: *215 + items: *216 + repository_discussions: *216 + repository_discussions_category: *216 required: - timeline - user @@ -24972,7 +25664,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *216 + - *217 - *17 - *19 responses: @@ -24982,7 +25674,7 @@ paths: application/json: schema: type: array - items: &217 + items: &218 title: Base Gist description: Base Gist type: object @@ -25081,7 +25773,7 @@ paths: - created_at - updated_at examples: - default: &218 + default: &219 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25202,7 +25894,7 @@ paths: description: Response content: application/json: - schema: &219 + schema: &220 title: Gist Simple description: Gist Simple type: object @@ -25219,7 +25911,7 @@ paths: url: type: string format: uri - user: &813 + user: &815 title: Public User description: Public User type: object @@ -25581,7 +26273,7 @@ paths: truncated: type: boolean examples: - default: &220 + default: &221 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -25685,7 +26377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *216 + - *217 - *17 - *19 responses: @@ -25695,9 +26387,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '422': *15 @@ -25719,7 +26411,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *216 + - *217 - *17 - *19 responses: @@ -25729,9 +26421,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '401': *25 @@ -25759,7 +26451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &221 + - &222 name: gist_id description: The unique identifier of the gist. in: path @@ -25771,10 +26463,10 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - default: *220 - '403': &224 + default: *221 + '403': &225 description: Forbidden Gist content: application/json: @@ -25822,7 +26514,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *221 + - *222 requestBody: required: true content: @@ -25882,9 +26574,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - updateGist: *220 + updateGist: *221 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26042,7 +26734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26071,7 +26763,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26081,7 +26773,7 @@ paths: application/json: schema: type: array - items: &222 + items: &223 title: Gist Comment description: A comment made to a gist. type: object @@ -26116,7 +26808,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *213 + author_association: *214 required: - url - id @@ -26181,7 +26873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *221 + - *222 requestBody: required: true content: @@ -26206,9 +26898,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: &223 + default: &224 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26266,8 +26958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *221 - - &225 + - *222 + - &226 name: comment_id description: The unique identifier of the comment. in: path @@ -26280,12 +26972,12 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *223 + default: *224 '304': *37 '404': *6 - '403': *224 + '403': *225 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26307,8 +26999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *221 - - *225 + - *222 + - *226 requestBody: required: true content: @@ -26333,9 +27025,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *223 + default: *224 '404': *6 x-github: githubCloudOnly: false @@ -26352,8 +27044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *221 - - *225 + - *222 + - *226 responses: '204': description: Response @@ -26376,7 +27068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26477,7 +27169,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26487,7 +27179,7 @@ paths: application/json: schema: type: array - items: *219 + items: *220 examples: default: value: @@ -26552,13 +27244,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *221 + - *222 responses: '201': description: Response content: application/json: - schema: *217 + schema: *218 examples: default: value: @@ -26629,7 +27321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *221 + - *222 responses: '204': description: Response if gist is starred @@ -26659,7 +27351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26681,7 +27373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26710,7 +27402,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *221 + - *222 - name: sha in: path required: true @@ -26721,9 +27413,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - default: *220 + default: *221 '422': *15 '404': *6 '403': *29 @@ -27089,7 +27781,7 @@ paths: - closed - all default: open - - &367 + - &371 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27108,7 +27800,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - name: collab in: query required: false @@ -27138,9 +27830,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: &368 + default: &372 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27424,8 +28116,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 examples: default: value: @@ -27710,7 +28402,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &229 + X-CommonMarker-Version: &230 example: 0.17.4 schema: type: string @@ -27765,7 +28457,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *229 + X-CommonMarker-Version: *230 content: text/html: schema: @@ -27794,7 +28486,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: - - &232 + - &233 name: account_id description: account_id parameter in: path @@ -27806,7 +28498,7 @@ paths: description: Response content: application/json: - schema: &231 + schema: &232 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -27836,7 +28528,7 @@ paths: nullable: true id: type: integer - plan: &230 + plan: &231 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27925,7 +28617,7 @@ paths: nullable: true updated_at: type: string - plan: *230 + plan: *231 required: - url - id @@ -27933,7 +28625,7 @@ paths: - login - marketplace_purchase examples: - default: &233 + default: &234 value: url: https://api.github.com/orgs/github type: Organization @@ -28018,9 +28710,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: &234 + default: &235 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28060,14 +28752,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &235 + - &236 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &236 + - &237 name: sort description: The property to sort the results by. in: query @@ -28097,9 +28789,9 @@ paths: application/json: schema: type: array - items: *231 + items: *232 examples: - default: &237 + default: &238 value: - url: https://api.github.com/orgs/github type: Organization @@ -28173,15 +28865,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: - - *232 + - *233 responses: '200': description: Response content: application/json: - schema: *231 + schema: *232 examples: - default: *233 + default: *234 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -28213,9 +28905,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: *234 + default: *235 headers: Link: *43 '401': *25 @@ -28238,8 +28930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *235 - *236 + - *237 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28259,9 +28951,9 @@ paths: application/json: schema: type: array - items: *231 + items: *232 examples: - default: *237 + default: *238 headers: Link: *43 '401': *25 @@ -28525,14 +29217,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: - - &466 + - &469 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &467 + - &470 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -28549,7 +29241,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -28594,7 +29286,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &480 + '301': &481 description: Moved permanently content: application/json: @@ -28616,7 +29308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &691 + - &693 name: all description: If `true`, show notifications marked as read. in: query @@ -28624,7 +29316,7 @@ paths: schema: type: boolean default: false - - &692 + - &694 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -28633,8 +29325,8 @@ paths: schema: type: boolean default: false - - *216 - - &693 + - *217 + - &695 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: @@ -28659,18 +29351,18 @@ paths: application/json: schema: type: array - items: &239 + items: &240 title: Thread description: Thread type: object properties: id: type: string - repository: &280 + repository: &284 title: Minimal Repository description: Minimal Repository type: object - properties: &337 + properties: &341 id: type: integer format: int64 @@ -28946,7 +29638,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &412 + security_and_analysis: &415 nullable: true type: object properties: @@ -29028,7 +29720,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &338 + required: &342 - archive_url - assignees_url - blobs_url @@ -29116,7 +29808,7 @@ paths: - url - subscription_url examples: - default: &694 + default: &696 value: - id: '1' repository: @@ -29282,7 +29974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &240 + - &241 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 @@ -29296,7 +29988,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *240 examples: default: value: @@ -29399,7 +30091,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *240 + - *241 responses: '205': description: Reset Content @@ -29422,7 +30114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *240 + - *241 responses: '204': description: No content @@ -29445,13 +30137,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: - - *240 + - *241 responses: '200': description: Response content: application/json: - schema: &241 + schema: &242 title: Thread Subscription description: Thread Subscription type: object @@ -29488,7 +30180,7 @@ paths: - url - subscribed examples: - default: &242 + default: &243 value: subscribed: true ignored: false @@ -29519,7 +30211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *240 + - *241 requestBody: required: false content: @@ -29540,9 +30232,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *242 examples: - default: *242 + default: *243 '304': *37 '403': *29 '401': *25 @@ -29565,7 +30257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *240 + - *241 responses: '204': description: Response @@ -29662,7 +30354,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: example: ; rel="next" @@ -29713,7 +30405,7 @@ paths: type: integer custom_roles: type: array - items: &323 + items: &327 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -29761,7 +30453,7 @@ paths: - created_at - updated_at examples: - default: &324 + default: &328 value: id: 8030 name: Security Engineer @@ -29852,8 +30544,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *244 - required: *245 + properties: *245 + required: *246 nullable: true additionalProperties: false examples: @@ -30087,7 +30779,7 @@ paths: type: array items: *151 examples: - default: &700 + default: &702 value: - property_name: environment value: production @@ -30137,7 +30829,7 @@ paths: required: - properties examples: - default: &701 + default: &703 value: properties: - property_name: environment @@ -30158,6 +30850,263 @@ 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: + - *83 + responses: + '200': *247 + '404': *6 + '403': *29 + '500': *40 + 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: + - *83 + - *193 + responses: + '200': *248 + '400': *14 + '404': *6 + '403': *29 + '500': *40 + '503': *190 + 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: + - *83 + - *193 + 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 + example: 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': *25 + '403': *29 + '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: + - *83 + - *193 + responses: + '200': *249 + '400': *14 + '404': *6 + '403': *29 + '500': *40 + '503': *190 + 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 @@ -30173,12 +31122,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *83 - - *196 - - *198 - *197 - - *246 - - *247 - - *200 + - *199 + - *198 + - *250 + - *251 + - *201 responses: '200': description: Response when getting a billing premium request usage report @@ -30310,17 +31259,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *83 - - *196 - - *248 - *197 + - *252 + - *198 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *249 + schema: *253 examples: - default: *250 + default: *254 '400': *14 '403': *29 '500': *40 @@ -30332,7 +31281,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. @@ -30345,18 +31294,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: - *83 - - *196 - - *198 - *197 - - *251 - - *200 - - *252 + - *199 + - *198 + - *255 + - *201 + - *256 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -30490,7 +31439,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &257 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -30823,7 +31772,7 @@ paths: - updated_at - archived_at examples: - default-response: &254 + default-response: &258 value: login: github id: 1 @@ -31148,17 +32097,17 @@ paths: description: Response content: application/json: - schema: *253 + schema: *257 examples: - default: *254 + default: *258 '422': description: Validation failed content: application/json: schema: oneOf: - - *255 - - *256 + - *259 + - *260 '409': *114 x-github: githubCloudOnly: false @@ -31213,9 +32162,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *261 examples: - default: *258 + default: *262 headers: Link: *43 x-github: @@ -31256,7 +32205,7 @@ paths: type: integer repository_cache_usages: type: array - items: &485 + items: &486 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31331,7 +32280,7 @@ paths: type: array items: *44 examples: - default: *259 + default: *263 headers: Link: *43 x-github: @@ -31497,7 +32446,7 @@ paths: application/json: schema: *45 examples: - default: *260 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31589,7 +32538,7 @@ paths: application/json: schema: *48 examples: - default: *261 + default: *265 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31708,9 +32657,9 @@ paths: description: Response content: application/json: - schema: *262 + schema: *266 examples: - default: *263 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31746,7 +32695,7 @@ paths: type: array items: *52 examples: - default: *264 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31934,7 +32883,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &265 + schema: &269 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -31948,7 +32897,7 @@ paths: required: - include_claim_keys examples: - default: &266 + default: &270 value: include_claim_keys: - repo @@ -31975,15 +32924,15 @@ paths: required: true content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 responses: '201': description: Empty response content: application/json: - schema: &291 + schema: &295 title: Empty Object description: An object without any properties. type: object @@ -32022,7 +32971,7 @@ paths: schema: type: object properties: - enabled_repositories: &268 + enabled_repositories: &272 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32036,7 +32985,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *56 - selected_actions_url: *267 + selected_actions_url: *271 sha_pinning_required: *57 required: - enabled_repositories @@ -32078,7 +33027,7 @@ paths: schema: type: object properties: - enabled_repositories: *268 + enabled_repositories: *272 allowed_actions: *56 sha_pinning_required: *57 required: @@ -32114,7 +33063,7 @@ paths: description: Response content: application/json: - schema: *269 + schema: *273 examples: response: summary: Example response @@ -32145,7 +33094,7 @@ paths: required: true content: application/json: - schema: *270 + schema: *274 examples: application/json: value: @@ -32183,7 +33132,7 @@ paths: application/json: schema: *58 examples: - default: *271 + default: *275 '404': *6 x-github: enabledForGitHubApps: true @@ -32240,7 +33189,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: default: *59 '403': *29 @@ -32265,7 +33214,7 @@ paths: required: true content: application/json: - schema: *273 + schema: *277 examples: default: *59 responses: @@ -32317,7 +33266,7 @@ paths: type: array items: *74 examples: - default: &275 + default: &279 value: total_count: 1 repositories: @@ -32502,7 +33451,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *83 - - &274 + - &278 name: repository_id description: The unique identifier of the repository. in: path @@ -32531,7 +33480,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -32727,7 +33676,7 @@ paths: type: array items: *74 examples: - default: *275 + default: *279 '403': *29 '404': *6 x-github: @@ -32796,7 +33745,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: - *83 - - *274 + - *278 responses: '204': description: No content @@ -32823,7 +33772,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: - *83 - - *274 + - *278 responses: '204': description: No content @@ -32857,7 +33806,7 @@ paths: description: Response content: application/json: - schema: *276 + schema: *280 examples: default: *65 x-github: @@ -32891,7 +33840,7 @@ paths: required: false content: application/json: - schema: *277 + schema: *281 examples: default: *65 x-github: @@ -32938,7 +33887,7 @@ paths: type: number runner_groups: type: array - items: &278 + items: &282 type: object properties: id: @@ -33126,9 +34075,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: &279 + default: &283 value: id: 2 name: octo-runner-group @@ -33170,7 +34119,7 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: default: value: @@ -33261,9 +34210,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: *279 + default: *283 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33327,7 +34276,7 @@ paths: type: array items: *44 examples: - default: *259 + default: *263 headers: Link: *43 x-github: @@ -33368,9 +34317,9 @@ paths: type: number repositories: type: array - items: *280 + items: *284 examples: - default: &816 + default: &818 value: total_count: 1 repositories: @@ -33669,7 +34618,7 @@ paths: parameters: - *83 - *68 - - *274 + - *278 responses: '204': description: Response @@ -33693,7 +34642,7 @@ paths: parameters: - *83 - *68 - - *274 + - *278 responses: '204': description: Response @@ -33911,9 +34860,9 @@ paths: application/json: schema: type: array - items: *281 + items: *285 examples: - default: *282 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33978,7 +34927,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *283 + '201': *287 '404': *6 '422': *7 '409': *114 @@ -34017,7 +34966,7 @@ paths: application/json: schema: *75 examples: - default: *284 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34053,7 +35002,7 @@ paths: application/json: schema: *75 examples: - default: *285 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34084,7 +35033,7 @@ paths: application/json: schema: *72 examples: - default: *286 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34259,7 +35208,7 @@ paths: - *83 - *71 responses: - '200': *287 + '200': *291 '404': *6 x-github: githubCloudOnly: false @@ -34288,7 +35237,7 @@ paths: parameters: - *83 - *71 - - *288 + - *292 responses: '200': *77 '404': *6 @@ -34333,7 +35282,7 @@ paths: type: integer secrets: type: array - items: &289 + items: &293 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34412,7 +35361,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &506 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34441,7 +35390,7 @@ paths: - key_id - key examples: - default: &506 + default: &507 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34467,7 +35416,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - *83 - - &290 + - &294 name: secret_name description: The name of the secret. in: path @@ -34479,7 +35428,7 @@ paths: description: Response content: application/json: - schema: *289 + schema: *293 examples: default: value: @@ -34510,7 +35459,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -34567,7 +35516,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -34594,7 +35543,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -34621,7 +35570,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -34639,9 +35588,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: &294 + default: &298 value: total_count: 1 repositories: @@ -34734,7 +35683,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -34787,7 +35736,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -34821,7 +35770,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -34854,7 +35803,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &490 + - &491 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)." @@ -34878,7 +35827,7 @@ paths: type: integer variables: type: array - items: &292 + items: &296 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35011,7 +35960,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -35037,7 +35986,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - *83 - - &293 + - &297 name: name description: The name of the variable. in: path @@ -35049,7 +35998,7 @@ paths: description: Response content: application/json: - schema: *292 + schema: *296 examples: default: value: @@ -35080,7 +36029,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - *83 - - *293 + - *297 requestBody: required: true content: @@ -35143,7 +36092,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - *83 - - *293 + - *297 responses: '204': description: Response @@ -35170,7 +36119,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *83 - - *293 + - *297 - *19 - *17 responses: @@ -35188,9 +36137,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 '409': description: Response when the visibility of the variable is not set to `selected` @@ -35217,7 +36166,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *83 - - *293 + - *297 requestBody: required: true content: @@ -35267,7 +36216,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *83 - - *293 + - *297 - name: repository_id in: path required: true @@ -35302,7 +36251,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *83 - - *293 + - *297 - name: repository_id in: path required: true @@ -35360,7 +36309,7 @@ paths: required: true content: application/json: - schema: *295 + schema: *299 examples: default: *81 parameters: @@ -35665,12 +36614,12 @@ paths: required: - subject_digests examples: - default: &844 + default: &846 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &845 + withPredicateType: &847 value: subject_digests: - sha256:abc123 @@ -35728,7 +36677,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &846 + default: &848 value: attestations_subject_digests: - sha256:abc: @@ -36077,7 +37026,7 @@ paths: initiator: type: string examples: - default: &519 + default: &520 value: attestations: - bundle: @@ -36203,10 +37152,10 @@ paths: required: false schema: type: string - - *296 - - *297 - - *298 - - *299 + - *300 + - *301 + - *302 + - *303 - *17 responses: '200': @@ -36215,9 +37164,9 @@ paths: application/json: schema: type: array - items: *300 + items: *304 examples: - default: *301 + default: *305 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36246,7 +37195,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36340,7 +37289,7 @@ paths: subcategory: bypass-requests parameters: - *83 - - &304 + - &308 name: repository_name description: The name of the repository to filter on. in: query @@ -36359,9 +37308,9 @@ paths: application/json: schema: type: array - items: *302 + items: *306 examples: - default: *303 + default: *307 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -36385,7 +37334,7 @@ paths: subcategory: delegated-bypass parameters: - *83 - - *304 + - *308 - *99 - *100 - *101 @@ -36399,9 +37348,9 @@ paths: application/json: schema: type: array - items: *305 + items: *309 examples: - default: *306 + default: *310 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -36428,7 +37377,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &308 + schema: &312 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -36454,7 +37403,7 @@ paths: application/json: schema: type: array - items: &309 + items: &313 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -36485,7 +37434,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *307 + items: *311 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -36503,7 +37452,7 @@ paths: type: string format: date-time nullable: true - state: *308 + state: *312 contact_link: description: The contact link of the campaign. type: string @@ -36723,9 +37672,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: &310 + default: &314 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -36808,9 +37757,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: *310 + default: *314 '404': *6 '422': description: Unprocessable Entity @@ -36887,7 +37836,7 @@ paths: type: string format: uri nullable: true - state: *308 + state: *312 examples: default: value: @@ -36897,9 +37846,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: *310 + default: *314 '400': description: Bad Request content: @@ -36966,8 +37915,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *83 - - *311 - - *312 + - *315 + - *316 - *104 - *105 - *19 @@ -36978,7 +37927,7 @@ paths: be returned. in: query required: false - schema: *313 + schema: *317 - name: sort description: The property by which to sort the results. in: query @@ -36994,7 +37943,7 @@ paths: be returned. in: query required: false - schema: &546 + schema: &547 type: string description: Severity of a code scanning alert. enum: @@ -37012,9 +37961,9 @@ paths: application/json: schema: type: array - items: *314 + items: *318 examples: - default: *315 + default: *319 headers: Link: *43 '404': *6 @@ -37229,7 +38178,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *316 + code_scanning_options: *320 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -37372,7 +38321,7 @@ paths: application/json: schema: *110 examples: - default: *317 + default: *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37400,9 +38349,9 @@ paths: description: Response content: application/json: - schema: *318 + schema: *322 examples: - default: *319 + default: *323 '304': *37 '403': *29 '404': *6 @@ -37489,7 +38438,7 @@ paths: application/json: schema: *110 examples: - default: *317 + default: *321 '304': *37 '403': *29 '404': *6 @@ -37911,7 +38860,7 @@ paths: default: value: default_for_new_repos: all - configuration: *317 + configuration: *321 '403': *29 '404': *6 x-github: @@ -37964,13 +38913,13 @@ paths: application/json: schema: type: array - items: *320 + items: *324 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *321 + repository: *325 '403': *29 '404': *6 x-github: @@ -38010,7 +38959,7 @@ paths: type: integer codespaces: type: array - items: &369 + items: &373 type: object title: Codespace description: A codespace. @@ -38035,12 +38984,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *280 + repository: *284 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &575 + properties: &576 name: type: string description: The name of the machine. @@ -38082,7 +39031,7 @@ paths: - ready - in_progress nullable: true - required: &576 + required: &577 - name - display_name - operating_system @@ -38287,7 +39236,7 @@ paths: - pulls_url - recent_folders examples: - default: &370 + default: &374 value: total_count: 3 codespaces: @@ -38911,7 +39860,7 @@ paths: type: integer secrets: type: array - items: &322 + items: &326 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -38950,7 +39899,7 @@ paths: - updated_at - visibility examples: - default: &577 + default: &578 value: total_count: 2 secrets: @@ -38988,7 +39937,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &579 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39017,7 +39966,7 @@ paths: - key_id - key examples: - default: &579 + default: &580 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39041,15 +39990,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *322 + schema: *326 examples: - default: &581 + default: &582 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -39077,7 +40026,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -39132,7 +40081,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -39159,7 +40108,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -39185,7 +40134,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -39203,9 +40152,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 '404': *6 x-github: githubCloudOnly: false @@ -39228,7 +40177,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -39279,7 +40228,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -39313,7 +40262,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -39902,13 +40851,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40120,7 +41069,7 @@ paths: type: integer custom_roles: type: array - items: *323 + items: *327 examples: default: value: @@ -40212,7 +41161,7 @@ paths: required: true content: application/json: - schema: &325 + schema: &329 type: object properties: name: @@ -40253,9 +41202,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40286,9 +41235,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: true @@ -40316,7 +41265,7 @@ paths: required: true content: application/json: - schema: &326 + schema: &330 type: object properties: name: @@ -40354,9 +41303,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40414,7 +41363,7 @@ paths: required: true content: application/json: - schema: *325 + schema: *329 examples: default: value: @@ -40428,9 +41377,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40467,9 +41416,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: true @@ -40503,7 +41452,7 @@ paths: required: true content: application/json: - schema: *326 + schema: *330 examples: default: value: @@ -40518,9 +41467,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40580,11 +41529,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *83 - - *327 - - *328 - - *329 - - *330 - *331 + - *332 + - *333 + - *334 + - *335 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -40622,8 +41571,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *332 - - *333 + - *336 + - *337 - *106 - *104 - *105 @@ -40635,9 +41584,9 @@ paths: application/json: schema: type: array - items: *334 + items: *338 examples: - default: *335 + default: *339 '304': *37 '400': *14 '403': *29 @@ -40681,7 +41630,7 @@ paths: type: integer secrets: type: array - items: &336 + items: &340 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -40758,7 +41707,7 @@ paths: description: Response content: application/json: - schema: &607 + schema: &608 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -40775,7 +41724,7 @@ paths: - key_id - key examples: - default: &608 + default: &609 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40799,13 +41748,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: default: value: @@ -40834,7 +41783,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -40893,7 +41842,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -40918,7 +41867,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -40943,7 +41892,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -40961,9 +41910,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40985,7 +41934,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -41036,7 +41985,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -41068,7 +42017,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -41105,7 +42054,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &616 + - &617 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41113,7 +42062,7 @@ paths: required: false schema: type: string - - &617 + - &618 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41121,7 +42070,7 @@ paths: required: false schema: type: string - - &618 + - &619 name: time_period description: |- The time period to filter by. @@ -41137,7 +42086,7 @@ paths: - week - month default: month - - &619 + - &620 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41152,7 +42101,7 @@ paths: - denied - all default: all - - *304 + - *308 - *17 - *19 responses: @@ -41162,7 +42111,7 @@ paths: application/json: schema: type: array - items: &620 + items: &621 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41318,7 +42267,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &621 + default: &622 value: - id: 21 number: 42 @@ -41405,11 +42354,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - *304 + - *308 - *99 - *100 - *101 - - &622 + - &623 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -41435,7 +42384,7 @@ paths: application/json: schema: type: array - items: &623 + items: &624 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -41556,7 +42505,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &624 + default: &625 value: - id: 21 number: 42 @@ -41644,7 +42593,7 @@ paths: application/json: schema: type: array - items: &380 + items: &384 title: Package description: A software package type: object @@ -41694,8 +42643,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *337 - required: *338 + properties: *341 + required: *342 nullable: true created_at: type: string @@ -41714,7 +42663,7 @@ paths: - created_at - updated_at examples: - default: &381 + default: &385 value: - id: 197 name: hello_docker @@ -41802,7 +42751,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: 200-response: value: @@ -41901,7 +42850,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &464 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -41982,7 +42931,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &462 + default: &465 value: group_id: '123' group_name: Octocat admins @@ -42037,7 +42986,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &462 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42074,7 +43023,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &460 + default: &463 value: groups: - group_id: '123' @@ -42118,7 +43067,7 @@ paths: application/json: schema: type: array - items: &361 + items: &365 title: Organization Invitation description: Organization Invitation type: object @@ -42165,7 +43114,7 @@ paths: - invitation_teams_url - node_id examples: - default: &362 + default: &366 value: - id: 1 login: monalisa @@ -42232,7 +43181,7 @@ paths: application/json: schema: type: array - items: &413 + items: &416 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -42246,7 +43195,7 @@ paths: - name - description examples: - default: &414 + default: &417 value: - name: add_assignee description: Assign or remove a user @@ -42287,7 +43236,7 @@ paths: application/json: schema: type: array - items: &339 + items: &343 title: Org Hook description: Org Hook type: object @@ -42456,9 +43405,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: - default: &340 + default: &344 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -42503,7 +43452,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - *83 - - &341 + - &345 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. @@ -42516,9 +43465,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: - default: *340 + default: *344 '404': *6 x-github: githubCloudOnly: false @@ -42540,7 +43489,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - *83 - - *341 + - *345 requestBody: required: false content: @@ -42585,7 +43534,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: default: value: @@ -42625,7 +43574,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - *83 - - *341 + - *345 responses: '204': description: Response @@ -42651,7 +43600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *83 - - *341 + - *345 responses: '200': description: Response @@ -42680,7 +43629,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *83 - - *341 + - *345 requestBody: required: false content: @@ -42729,9 +43678,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *17 - - *342 + - *346 responses: '200': description: Response @@ -42739,9 +43688,9 @@ paths: application/json: schema: type: array - items: *343 + items: *347 examples: - default: *344 + default: *348 '400': *14 '422': *15 x-github: @@ -42765,16 +43714,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *16 responses: '200': description: Response content: application/json: - schema: *345 + schema: *349 examples: - default: *346 + default: *350 '400': *14 '422': *15 x-github: @@ -42798,7 +43747,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *16 responses: '202': *39 @@ -42825,7 +43774,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - *83 - - *341 + - *345 responses: '204': description: Response @@ -42848,7 +43797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - *83 - - &351 + - &355 name: actor_type in: path description: The type of the actor @@ -42861,14 +43810,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &352 + - &356 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &347 + - &351 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`.' @@ -42876,7 +43825,7 @@ paths: required: true schema: type: string - - &348 + - &352 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) @@ -42970,12 +43919,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - *83 - - *347 - - *348 + - *351 + - *352 - *19 - *17 - *106 - - &357 + - &361 name: sort description: The property to sort the results by. in: query @@ -43054,14 +44003,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - *83 - - *347 - - *348 + - *351 + - *352 responses: '200': description: Response content: application/json: - schema: &349 + schema: &353 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -43077,7 +44026,7 @@ paths: type: integer format: int64 examples: - default: &350 + default: &354 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -43098,23 +44047,23 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - *83 - - &353 + - &357 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *347 - - *348 + - *351 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *350 + default: *354 x-github: enabledForGitHubApps: true category: orgs @@ -43133,18 +44082,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *83 - - *347 - - *348 - *351 - *352 + - *355 + - *356 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *350 + default: *354 x-github: enabledForGitHubApps: true category: orgs @@ -43162,9 +44111,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - *83 - - *347 - - *348 - - &354 + - *351 + - *352 + - &358 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -43177,7 +44126,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &359 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -43193,7 +44142,7 @@ paths: type: integer format: int64 examples: - default: &356 + default: &360 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -43230,18 +44179,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - *83 - - *353 - - *347 - - *348 - - *354 + - *357 + - *351 + - *352 + - *358 responses: '200': description: Response content: application/json: - schema: *355 + schema: *359 examples: - default: *356 + default: *360 x-github: enabledForGitHubApps: true category: orgs @@ -43259,19 +44208,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - *83 + - *355 + - *356 - *351 - *352 - - *347 - - *348 - - *354 + - *358 responses: '200': description: Response content: application/json: - schema: *355 + schema: *359 examples: - default: *356 + default: *360 x-github: enabledForGitHubApps: true category: orgs @@ -43289,13 +44238,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - *83 - - *353 - - *347 - - *348 + - *357 + - *351 + - *352 - *19 - *17 - *106 - - *357 + - *361 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43376,7 +44325,7 @@ paths: application/json: schema: *22 examples: - default: &655 + default: &656 value: id: 1 account: @@ -43542,12 +44491,12 @@ paths: application/json: schema: anyOf: - - &359 + - &363 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &358 + limit: &362 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -43572,7 +44521,7 @@ paths: properties: {} additionalProperties: false examples: - default: &360 + default: &364 value: limit: collaborators_only origin: organization @@ -43601,13 +44550,13 @@ paths: required: true content: application/json: - schema: &656 + schema: &657 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *358 + limit: *362 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -43631,9 +44580,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 '422': *15 x-github: githubCloudOnly: false @@ -43711,9 +44660,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 '404': *6 @@ -43791,7 +44740,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -43848,7 +44797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *83 - - &363 + - &367 name: invitation_id description: The unique identifier of the invitation. in: path @@ -43882,7 +44831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *83 - - *363 + - *367 - *17 - *19 responses: @@ -43892,9 +44841,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: &379 + default: &383 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -43937,7 +44886,7 @@ paths: application/json: schema: type: array - items: *364 + items: *368 examples: default: value: @@ -44022,9 +44971,9 @@ paths: description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: &365 + default: &369 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -44057,7 +45006,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *83 - - &366 + - &370 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -44110,9 +45059,9 @@ paths: description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: *365 + default: *369 '404': *6 '422': *7 x-github: @@ -44137,7 +45086,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *83 - - *366 + - *370 responses: '204': description: Response @@ -44200,7 +45149,7 @@ paths: - closed - all default: open - - *367 + - *371 - name: type description: Can be the name of an issue type. in: query @@ -44219,7 +45168,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -44229,9 +45178,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *368 + default: *372 headers: Link: *43 '404': *6 @@ -44291,7 +45240,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '422': *15 @@ -44390,9 +45339,9 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: - default: *370 + default: *374 '304': *37 '500': *40 '401': *25 @@ -44419,7 +45368,7 @@ paths: parameters: - *83 - *138 - - &371 + - &375 name: codespace_name in: path required: true @@ -44454,15 +45403,15 @@ paths: parameters: - *83 - *138 - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: &574 + default: &575 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -44718,7 +45667,7 @@ paths: description: Response content: application/json: - schema: &372 + schema: &376 title: Org Membership description: Org Membership type: object @@ -44785,7 +45734,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &373 + response-if-user-has-an-active-admin-membership-with-organization: &377 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -44882,9 +45831,9 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: - response-if-user-already-had-membership-with-organization: *373 + response-if-user-already-had-membership-with-organization: *377 '422': *15 '403': *29 x-github: @@ -44955,7 +45904,7 @@ paths: application/json: schema: type: array - items: &374 + items: &378 title: Migration description: A migration. type: object @@ -45284,7 +46233,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -45463,7 +46412,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *83 - - &375 + - &379 name: migration_id description: The unique identifier of the migration. in: path @@ -45490,7 +46439,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -45660,7 +46609,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *83 - - *375 + - *379 responses: '302': description: Response @@ -45682,7 +46631,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *83 - - *375 + - *379 responses: '204': description: Response @@ -45706,8 +46655,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *83 - - *375 - - &829 + - *379 + - &831 name: repo_name description: repo_name parameter in: path @@ -45735,7 +46684,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *83 - - *375 + - *379 - *17 - *19 responses: @@ -45745,9 +46694,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: &386 + default: &390 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45956,7 +46905,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &376 + items: &380 title: Organization Role description: Organization roles type: object @@ -46163,7 +47112,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46215,7 +47164,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -46241,7 +47190,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *83 - - *209 + - *210 - *137 responses: '204': @@ -46272,7 +47221,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *83 - - *209 + - *210 - *137 responses: '204': @@ -46393,7 +47342,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46490,7 +47439,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46648,8 +47597,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 nullable: true type: description: The ownership type of the team @@ -46681,7 +47630,7 @@ paths: - type - parent examples: - default: *379 + default: *383 headers: Link: *43 '404': @@ -46739,13 +47688,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &433 + items: &436 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 name: nullable: true type: string @@ -46840,7 +47789,7 @@ paths: - type - url examples: - default: *206 + default: *207 headers: Link: *43 '404': @@ -46891,7 +47840,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -47033,7 +47982,7 @@ paths: - nuget - container - *83 - - &830 + - &832 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47069,12 +48018,12 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *381 + default: *385 '403': *29 '401': *25 - '400': &832 + '400': &834 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -47096,7 +48045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &382 + - &386 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 @@ -47114,7 +48063,7 @@ paths: - docker - nuget - container - - &383 + - &387 name: package_name description: The name of the package. in: path @@ -47127,7 +48076,7 @@ paths: description: Response content: application/json: - schema: *380 + schema: *384 examples: default: value: @@ -47179,8 +48128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 responses: '204': @@ -47213,8 +48162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - name: token description: package token @@ -47247,8 +48196,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: - - *382 - - *383 + - *386 + - *387 - *83 - *19 - *17 @@ -47269,7 +48218,7 @@ paths: application/json: schema: type: array - items: &384 + items: &388 title: Package Version description: A version of a software package type: object @@ -47394,10 +48343,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: - - *382 - - *383 + - *386 + - *387 - *83 - - &385 + - &389 name: package_version_id description: Unique identifier of the package version. in: path @@ -47409,7 +48358,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -47445,10 +48394,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - - *385 + - *389 responses: '204': description: Response @@ -47480,10 +48429,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - - *385 + - *389 responses: '204': description: Response @@ -47513,7 +48462,7 @@ paths: - *83 - *17 - *19 - - &387 + - &391 name: sort description: The property by which to sort the results. in: query @@ -47524,7 +48473,7 @@ paths: - created_at default: created_at - *106 - - &388 + - &392 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -47535,7 +48484,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &389 + - &393 name: repository description: The name of the repository to use to filter the results. in: query @@ -47543,7 +48492,7 @@ paths: schema: type: string example: Hello-World - - &390 + - &394 name: permission description: The permission to use to filter the results. in: query @@ -47551,7 +48500,7 @@ paths: schema: type: string example: issues_read - - &391 + - &395 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) @@ -47561,7 +48510,7 @@ paths: schema: type: string format: date-time - - &392 + - &396 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) @@ -47571,7 +48520,7 @@ paths: schema: type: string format: date-time - - &393 + - &397 name: token_id description: The ID of the token in: query @@ -47882,9 +48831,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -47910,14 +48859,14 @@ paths: - *83 - *17 - *19 - - *387 - - *106 - - *388 - - *389 - - *390 - *391 + - *106 - *392 - *393 + - *394 + - *395 + - *396 + - *397 responses: '500': *40 '422': *15 @@ -48197,9 +49146,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -48241,7 +49190,7 @@ paths: type: integer configurations: type: array - items: &394 + items: &398 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48531,7 +49480,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &395 + org-private-registry-with-selected-visibility: &399 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -48621,15 +49570,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *394 + schema: *398 examples: - default: *395 + default: *399 '404': *6 x-github: githubCloudOnly: false @@ -48651,7 +49600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -48756,7 +49705,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -48767,266 +49716,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: - - *83 - - 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: &396 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week - in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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: *43 - '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: - - *83 - 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: *396 - 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': *25 - '403': *29 - '404': *6 - '410': &477 - 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 @@ -49056,7 +49745,7 @@ paths: application/json: schema: type: array - items: &397 + items: &400 title: Projects v2 Project description: A projects v2 project type: object @@ -49126,7 +49815,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &910 + properties: &912 id: type: number description: The unique identifier of the status update. @@ -49174,7 +49863,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &911 + required: &913 - id - node_id - created_at @@ -49199,7 +49888,7 @@ paths: - deleted_at - deleted_by examples: - default: &398 + default: &401 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49302,7 +49991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &399 + - &402 name: project_number description: The project's number. in: path @@ -49315,9 +50004,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -49339,7 +50028,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *399 + - *402 - *83 - *17 - *104 @@ -49351,7 +50040,7 @@ paths: application/json: schema: type: array - items: &400 + items: &403 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -49498,7 +50187,7 @@ paths: - updated_at - project_url examples: - default: &849 + default: &851 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49601,8 +50290,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *399 - - &850 + - *402 + - &852 name: field_id description: The unique identifier of the field. in: path @@ -49615,9 +50304,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: &851 + default: &853 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49661,7 +50350,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: - - *399 + - *402 - *83 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -49694,7 +50383,7 @@ paths: application/json: schema: type: array - items: &406 + items: &409 title: Projects v2 Item description: An item belonging to a project type: object @@ -49710,7 +50399,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &404 + content_type: &407 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -49760,7 +50449,7 @@ paths: - updated_at - archived_at examples: - default: &407 + default: &410 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -50455,7 +51144,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *83 - - *399 + - *402 requestBody: required: true description: Details of the item to add to the project. @@ -50492,7 +51181,7 @@ paths: description: Response content: application/json: - schema: &852 + schema: &854 title: Projects v2 Item description: An item belonging to a project type: object @@ -50505,8 +51194,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *226 - - &589 + - *227 + - &590 title: Pull Request Simple description: Pull Request Simple type: object @@ -50612,8 +51301,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true active_lock_reason: type: string @@ -50658,7 +51347,7 @@ paths: nullable: true requested_teams: type: array - items: *307 + items: *311 nullable: true head: type: object @@ -50709,7 +51398,7 @@ paths: _links: type: object properties: - comments: &403 + comments: &406 title: Link description: Hypermedia Link type: object @@ -50718,13 +51407,13 @@ paths: type: string required: - href - commits: *403 - statuses: *403 - html: *403 - issue: *403 - review_comments: *403 - review_comment: *403 - self: *403 + commits: *406 + statuses: *406 + html: *406 + issue: *406 + review_comments: *406 + review_comment: *406 + self: *406 required: - comments - commits @@ -50734,8 +51423,8 @@ paths: - review_comments - review_comment - self - author_association: *213 - auto_merge: &703 + author_association: *214 + auto_merge: &705 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50837,7 +51526,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *404 + content_type: *407 creator: *4 created_at: type: string @@ -50870,7 +51559,7 @@ paths: - updated_at - archived_at examples: - issue: &405 + issue: &408 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50925,7 +51614,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: *405 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -50945,9 +51634,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: - - *399 + - *402 - *83 - - &408 + - &411 name: item_id description: The unique identifier of the project item. in: path @@ -50973,9 +51662,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -50996,9 +51685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *399 + - *402 - *83 - - *408 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -51068,13 +51757,13 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - text_field: *407 - number_field: *407 - date_field: *407 - single_select_field: *407 - iteration_field: *407 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -51094,9 +51783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *399 + - *402 - *83 - - *408 + - *411 responses: '204': description: Response @@ -51259,7 +51948,7 @@ paths: required: true content: application/json: - schema: *409 + schema: *412 examples: default: value: @@ -51484,7 +52173,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -51622,9 +52311,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -51827,7 +52516,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &480 title: Full Repository description: Full Repository type: object @@ -52104,8 +52793,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *410 - required: *411 + properties: *413 + required: *414 nullable: true temp_clone_token: type: string @@ -52192,8 +52881,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true organization: title: Simple User @@ -52220,7 +52909,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &594 + properties: &595 url: type: string format: uri @@ -52236,12 +52925,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &595 + required: &596 - url - key - name - html_url - security_and_analysis: *412 + security_and_analysis: *415 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -52325,7 +53014,7 @@ paths: - network_count - subscribers_count examples: - default: &481 + default: &482 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -52851,9 +53540,9 @@ paths: application/json: schema: type: array - items: *413 + items: *416 examples: - default: *414 + default: *417 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -52878,7 +53567,7 @@ paths: - *83 - *17 - *19 - - &726 + - &728 name: targets description: | A comma-separated list of rule targets to filter by. @@ -52969,11 +53658,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *164 - conditions: *415 + conditions: *418 rules: type: array description: An array of rules within the ruleset. - items: &417 + items: &420 title: Repository Rule type: object description: A repository rule. @@ -53037,7 +53726,7 @@ paths: application/json: schema: *185 examples: - default: &416 + default: &419 value: id: 21 name: super cool ruleset @@ -53092,7 +53781,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &728 + - &730 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 @@ -53102,16 +53791,16 @@ paths: schema: type: string x-multi-segment: true - - *304 + - *308 - *101 - - &729 + - &731 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 - - &730 + - &732 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53131,7 +53820,7 @@ paths: description: Response content: application/json: - schema: &731 + schema: &733 title: Rule Suites description: Response type: array @@ -53186,7 +53875,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &732 + default: &734 value: - id: 21 actor_id: 12 @@ -53230,7 +53919,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &733 + - &735 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53246,7 +53935,7 @@ paths: description: Response content: application/json: - schema: &734 + schema: &736 title: Rule Suite description: Response type: object @@ -53345,7 +54034,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &735 + default: &737 value: id: 21 actor_id: 12 @@ -53420,7 +54109,7 @@ paths: application/json: schema: *185 examples: - default: *416 + default: *419 '404': *6 '500': *40 put: @@ -53469,11 +54158,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *164 - conditions: *415 + conditions: *418 rules: description: An array of rules within the ruleset. type: array - items: *417 + items: *420 examples: default: value: @@ -53510,7 +54199,7 @@ paths: application/json: schema: *185 examples: - default: *416 + default: *419 '404': *6 '500': *40 delete: @@ -53569,7 +54258,7 @@ paths: type: array items: *189 examples: - default: *418 + default: *421 '404': *6 '500': *40 x-github: @@ -53606,7 +54295,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *422 examples: default: value: @@ -53669,14 +54358,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *83 - - *420 - - *421 - - *422 - *423 + - *424 + - *425 + - *426 - *106 - *19 - *17 - - &737 + - &739 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 @@ -53686,7 +54375,7 @@ paths: required: false schema: type: string - - &738 + - &740 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 @@ -53696,10 +54385,10 @@ paths: required: false schema: type: string - - *424 - - *425 - - *426 - *427 + - *428 + - *429 + - *430 responses: '200': description: Response @@ -53707,9 +54396,9 @@ paths: application/json: schema: type: array - items: *428 + items: *431 examples: - default: *429 + default: *432 headers: Link: *43 '404': *6 @@ -53744,9 +54433,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *433 examples: - default: *431 + default: *434 '403': *29 '404': *6 patch: @@ -53899,7 +54588,7 @@ paths: application/json: schema: type: array - items: &759 + items: &761 description: A repository security advisory. type: object properties: @@ -54119,7 +54808,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 credits_detailed: type: array nullable: true @@ -54129,7 +54818,7 @@ paths: type: object properties: user: *4 - type: *432 + type: *435 state: type: string description: The state of the user's acceptance of the @@ -54153,7 +54842,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *307 + items: *311 private_fork: readOnly: true nullable: true @@ -54190,7 +54879,7 @@ paths: - private_fork additionalProperties: false examples: - default: &760 + default: &762 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54577,9 +55266,9 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: *379 + default: *383 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54603,7 +55292,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -54629,7 +55318,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -54664,9 +55353,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54691,7 +55380,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *436 + - *439 - *17 - *19 responses: @@ -54699,9 +55388,9 @@ paths: description: Success content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54729,9 +55418,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *442 examples: - default: *440 + default: *443 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54759,9 +55448,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54905,9 +55594,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54976,7 +55665,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -54999,7 +55688,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -55042,7 +55731,7 @@ paths: type: array items: *143 examples: - default: *443 + default: *446 headers: Link: *43 x-github: @@ -55243,15 +55932,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: - *83 - - *444 + - *447 responses: '200': description: Response content: application/json: - schema: *445 + schema: *448 examples: - default: *446 + default: *449 headers: Link: *43 x-github: @@ -55289,7 +55978,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &471 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55335,7 +56024,7 @@ paths: type: string nullable: true examples: - default: &469 + default: &472 value: groups: - group_id: '123' @@ -55381,7 +56070,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *83 - - *209 + - *210 - 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`). @@ -55413,13 +56102,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55447,9 +56136,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 headers: Link: *43 '403': *29 @@ -55543,7 +56232,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &450 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55606,8 +56295,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 nullable: true members_count: type: integer @@ -55870,7 +56559,7 @@ paths: - repos_count - organization examples: - default: &448 + default: &451 value: id: 1 node_id: MDQ6VGVhbTE= @@ -55941,15 +56630,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 x-github: githubCloudOnly: false @@ -55971,7 +56660,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - *83 - - *209 + - *210 requestBody: required: false content: @@ -56033,16 +56722,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '201': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 '422': *15 '403': *29 @@ -56068,7 +56757,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -56095,7 +56784,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - *83 - - *209 + - *210 - *106 - *17 - *19 @@ -56112,7 +56801,7 @@ paths: application/json: schema: type: array - items: &449 + items: &452 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56191,7 +56880,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *214 + reactions: *215 required: - author - body @@ -56211,7 +56900,7 @@ paths: - updated_at - url examples: - default: &803 + default: &805 value: - author: login: octocat @@ -56286,7 +56975,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - *83 - - *209 + - *210 requestBody: required: true content: @@ -56320,9 +57009,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &450 + default: &453 value: author: login: octocat @@ -56395,8 +57084,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - *83 - - *209 - - &451 + - *210 + - &454 name: discussion_number description: The number that identifies the discussion. in: path @@ -56408,9 +57097,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56433,8 +57122,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: false content: @@ -56457,9 +57146,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &804 + default: &806 value: author: login: octocat @@ -56530,8 +57219,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 responses: '204': description: Response @@ -56558,8 +57247,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - *83 - - *209 - - *451 + - *210 + - *454 - *106 - *17 - *19 @@ -56570,7 +57259,7 @@ paths: application/json: schema: type: array - items: &452 + items: &455 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56627,7 +57316,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *214 + reactions: *215 required: - author - body @@ -56642,7 +57331,7 @@ paths: - updated_at - url examples: - default: &805 + default: &807 value: - author: login: octocat @@ -56711,8 +57400,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: true content: @@ -56734,9 +57423,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: &453 + default: &456 value: author: login: octocat @@ -56803,9 +57492,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - *83 - - *209 - - *451 - - &454 + - *210 + - *454 + - &457 name: comment_number description: The number that identifies the comment. in: path @@ -56817,9 +57506,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56842,9 +57531,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 requestBody: required: true content: @@ -56866,9 +57555,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: &806 + default: &808 value: author: login: octocat @@ -56933,9 +57622,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 responses: '204': description: Response @@ -56962,9 +57651,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 - 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. @@ -56990,7 +57679,7 @@ paths: application/json: schema: type: array - items: &455 + items: &458 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57033,7 +57722,7 @@ paths: - content - created_at examples: - default: &457 + default: &460 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57084,9 +57773,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 requestBody: required: true content: @@ -57119,9 +57808,9 @@ paths: team discussion comment content: application/json: - schema: *455 + schema: *458 examples: - default: &456 + default: &459 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57150,9 +57839,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57176,10 +57865,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - *83 - - *209 - - *451 + - *210 - *454 - - &458 + - *457 + - &461 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57212,8 +57901,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 - 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. @@ -57239,9 +57928,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -57268,8 +57957,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: true content: @@ -57301,16 +57990,16 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57334,9 +58023,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - *83 - - *209 - - *451 - - *458 + - *210 + - *454 + - *461 responses: '204': description: Response @@ -57360,15 +58049,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: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *459 + schema: *462 examples: - default: *460 + default: *463 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57388,7 +58077,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: - *83 - - *209 + - *210 requestBody: required: true content: @@ -57411,9 +58100,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57433,7 +58122,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: - *83 - - *209 + - *210 responses: '204': description: Response @@ -57458,7 +58147,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -57468,9 +58157,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 x-github: @@ -57493,7 +58182,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - *83 - - *209 + - *210 - name: role description: Filters members returned by their role in the team. in: query @@ -57516,7 +58205,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -57547,14 +58236,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 responses: '200': description: Response content: application/json: - schema: &463 + schema: &466 title: Team Membership description: Team Membership type: object @@ -57581,7 +58270,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &807 + response-if-user-is-a-team-maintainer: &809 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57618,7 +58307,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 requestBody: required: false @@ -57644,9 +58333,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-users-membership-with-team-is-now-pending: &808 + response-if-users-membership-with-team-is-now-pending: &810 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -57682,7 +58371,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 responses: '204': @@ -57709,7 +58398,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -57719,7 +58408,7 @@ paths: application/json: schema: type: array - items: &464 + items: &467 title: Team Project description: A team's access to a project. type: object @@ -57787,7 +58476,7 @@ paths: - updated_at - permissions examples: - default: &809 + default: &811 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57851,8 +58540,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - *83 - - *209 - - &465 + - *210 + - &468 name: project_id description: The unique identifier of the project. in: path @@ -57864,9 +58553,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: &810 + default: &812 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57929,8 +58618,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - *83 - - *209 - - *465 + - *210 + - *468 requestBody: required: false content: @@ -57997,8 +58686,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - *83 - - *209 - - *465 + - *210 + - *468 responses: '204': description: Response @@ -58026,7 +58715,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -58036,9 +58725,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -58068,15 +58757,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &811 + schema: &813 title: Team Repository description: A team's access to a repository. type: object @@ -58099,8 +58788,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true forks: type: integer @@ -58646,9 +59335,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 requestBody: required: false content: @@ -58694,9 +59383,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 responses: '204': description: Response @@ -58723,15 +59412,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58754,7 +59443,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *83 - - *209 + - *210 requestBody: required: true content: @@ -58797,7 +59486,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -58830,7 +59519,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -58840,9 +59529,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - response-if-child-teams-exist: &812 + response-if-child-teams-exist: &814 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -58969,7 +59658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &470 + - &473 name: card_id description: The unique identifier of the card. in: path @@ -58981,7 +59670,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &474 title: Project Card description: Project cards represent a scope of work. type: object @@ -59048,7 +59737,7 @@ paths: - created_at - updated_at examples: - default: &472 + default: &475 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59104,7 +59793,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *470 + - *473 requestBody: required: false content: @@ -59131,9 +59820,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *474 examples: - default: *472 + default: *475 '304': *37 '403': *29 '401': *25 @@ -59160,7 +59849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *470 + - *473 responses: '204': description: Response @@ -59204,7 +59893,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *470 + - *473 requestBody: required: true content: @@ -59315,7 +60004,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &473 + - &476 name: column_id description: The unique identifier of the column. in: path @@ -59327,7 +60016,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &477 title: Project Column description: Project columns contain cards of work. type: object @@ -59373,7 +60062,7 @@ paths: - created_at - updated_at examples: - default: &475 + default: &478 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59408,7 +60097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *473 + - *476 requestBody: required: true content: @@ -59432,9 +60121,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 '304': *37 '403': *29 '401': *25 @@ -59459,7 +60148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *473 + - *476 responses: '204': description: Response @@ -59488,7 +60177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *473 + - *476 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59509,7 +60198,7 @@ paths: application/json: schema: type: array - items: *471 + items: *474 examples: default: value: @@ -59568,7 +60257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *473 + - *476 requestBody: required: true content: @@ -59608,9 +60297,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *474 examples: - default: *472 + default: *475 '304': *37 '403': *29 '401': *25 @@ -59620,8 +60309,8 @@ paths: application/json: schema: oneOf: - - *255 - - *256 + - *259 + - *260 '503': description: Response content: @@ -59666,7 +60355,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *473 + - *476 requestBody: required: true content: @@ -59712,208 +60401,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: - - *465 - responses: - '200': - description: Response - content: - application/json: - schema: *396 - examples: - default: &476 - 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': *37 - '403': *29 - '401': *25 - 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: - - *465 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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: *396 - examples: - default: *476 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *477 - '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: - - *465 - responses: - '204': - description: Delete Success - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *477 - '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 @@ -59928,7 +60415,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *465 + - *468 - 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 @@ -59955,7 +60442,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -59985,7 +60472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *465 + - *468 - *138 requestBody: required: false @@ -60038,7 +60525,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *465 + - *468 - *138 responses: '204': @@ -60070,7 +60557,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: - - *465 + - *468 - *138 responses: '200': @@ -60171,7 +60658,7 @@ paths: resources: type: object properties: - core: &478 + core: &479 title: Rate Limit type: object properties: @@ -60188,21 +60675,21 @@ paths: - remaining - reset - used - graphql: *478 - search: *478 - code_search: *478 - source_import: *478 - integration_manifest: *478 - code_scanning_upload: *478 - actions_runner_registration: *478 - scim: *478 - dependency_snapshots: *478 - dependency_sbom: *478 - code_scanning_autofix: *478 + graphql: *479 + search: *479 + code_search: *479 + source_import: *479 + integration_manifest: *479 + code_scanning_upload: *479 + actions_runner_registration: *479 + scim: *479 + dependency_snapshots: *479 + dependency_sbom: *479 + code_scanning_autofix: *479 required: - core - search - rate: *478 + rate: *479 required: - rate - resources @@ -60307,14 +60794,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *479 + schema: *480 examples: default-response: summary: Default response @@ -60819,7 +61306,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *480 + '301': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60837,8 +61324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -61095,10 +61582,10 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 - '307': &482 + default: *482 + '307': &483 description: Temporary Redirect content: application/json: @@ -61127,8 +61614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -61150,7 +61637,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': *482 + '307': *483 '404': *6 '409': *114 x-github: @@ -61174,11 +61661,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - - &497 + - &498 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61201,7 +61688,7 @@ paths: type: integer artifacts: type: array - items: &483 + items: &484 title: Artifact description: An artifact type: object @@ -61279,7 +61766,7 @@ paths: - expires_at - updated_at examples: - default: &498 + default: &499 value: total_count: 2 artifacts: @@ -61340,9 +61827,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *466 - - *467 - - &484 + - *469 + - *470 + - &485 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61354,7 +61841,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: default: value: @@ -61392,9 +61879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *466 - - *467 - - *484 + - *469 + - *470 + - *485 responses: '204': description: Response @@ -61418,9 +61905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *466 - - *467 - - *484 + - *469 + - *470 + - *485 - name: archive_format in: path required: true @@ -61434,7 +61921,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': *477 + '410': &660 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61457,14 +61948,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: default: value: @@ -61490,11 +61981,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: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - - &486 + - &487 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 @@ -61528,7 +62019,7 @@ paths: description: Response content: application/json: - schema: &487 + schema: &488 title: Repository actions caches description: Repository actions caches type: object @@ -61570,7 +62061,7 @@ paths: - total_count - actions_caches examples: - default: &488 + default: &489 value: total_count: 1 actions_caches: @@ -61602,23 +62093,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: - - *466 - - *467 + - *469 + - *470 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *486 + - *487 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61638,8 +62129,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: - - *466 - - *467 + - *469 + - *470 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61670,9 +62161,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: - - *466 - - *467 - - &489 + - *469 + - *470 + - &490 name: job_id description: The unique identifier of the job. in: path @@ -61684,7 +62175,7 @@ paths: description: Response content: application/json: - schema: &501 + schema: &502 title: Job description: Information of a job execution in a workflow run type: object @@ -61991,9 +62482,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: - - *466 - - *467 - - *489 + - *469 + - *470 + - *490 responses: '302': description: Response @@ -62021,9 +62512,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: - - *466 - - *467 - - *489 + - *469 + - *470 + - *490 requestBody: required: false content: @@ -62044,7 +62535,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -62068,8 +62559,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Status response @@ -62119,8 +62610,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -62154,7 +62645,7 @@ paths: description: Empty response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -62183,8 +62674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -62202,7 +62693,7 @@ paths: type: integer secrets: type: array - items: &503 + items: &504 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62222,7 +62713,7 @@ paths: - created_at - updated_at examples: - default: &504 + default: &505 value: total_count: 2 secrets: @@ -62255,9 +62746,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *466 - - *467 - - *490 + - *469 + - *470 + - *491 - *19 responses: '200': @@ -62274,7 +62765,7 @@ paths: type: integer variables: type: array - items: &507 + items: &508 title: Actions Variable type: object properties: @@ -62304,7 +62795,7 @@ paths: - created_at - updated_at examples: - default: &508 + default: &509 value: total_count: 2 variables: @@ -62337,8 +62828,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62347,11 +62838,11 @@ paths: schema: type: object properties: - enabled: &491 + enabled: &492 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 - selected_actions_url: *267 + selected_actions_url: *271 sha_pinning_required: *57 required: - enabled @@ -62382,8 +62873,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62394,7 +62885,7 @@ paths: schema: type: object properties: - enabled: *491 + enabled: *492 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62427,14 +62918,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &492 + schema: &493 type: object properties: access_level: @@ -62452,7 +62943,7 @@ paths: required: - access_level examples: - default: &493 + default: &494 value: access_level: organization x-github: @@ -62477,15 +62968,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *492 + schema: *493 examples: - default: *493 + default: *494 responses: '204': description: Response @@ -62509,14 +63000,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *269 + schema: *273 examples: default: value: @@ -62540,8 +63031,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Empty response for successful settings update @@ -62551,7 +63042,7 @@ paths: required: true content: application/json: - schema: *270 + schema: *274 examples: default: summary: Set retention days @@ -62575,8 +63066,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62584,7 +63075,7 @@ paths: application/json: schema: *58 examples: - default: *271 + default: *275 '404': *6 x-github: enabledForGitHubApps: true @@ -62603,8 +63094,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62638,14 +63129,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *272 + schema: *276 examples: default: *59 '403': *29 @@ -62667,13 +63158,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *273 + schema: *277 examples: default: *59 responses: @@ -62699,8 +63190,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62731,8 +63222,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62764,14 +63255,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *276 + schema: *280 examples: default: *65 x-github: @@ -62794,8 +63285,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Success response @@ -62806,7 +63297,7 @@ paths: required: true content: application/json: - schema: *277 + schema: *281 examples: default: *65 x-github: @@ -62835,8 +63326,8 @@ paths: in: query schema: type: string - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -62880,8 +63371,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62889,9 +63380,9 @@ paths: application/json: schema: type: array - items: *281 + items: *285 examples: - default: *282 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62913,8 +63404,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -62957,7 +63448,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *283 + '201': *287 '404': *6 '422': *7 '409': *114 @@ -62988,8 +63479,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: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -62997,7 +63488,7 @@ paths: application/json: schema: *75 examples: - default: *284 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63025,8 +63516,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: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -63034,7 +63525,7 @@ paths: application/json: schema: *75 examples: - default: *285 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63056,8 +63547,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '200': @@ -63066,7 +63557,7 @@ paths: application/json: schema: *72 examples: - default: *286 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63087,8 +63578,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '204': @@ -63115,8 +63606,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '200': *77 @@ -63141,8 +63632,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: - - *466 - - *467 + - *469 + - *470 - *71 requestBody: required: true @@ -63191,8 +63682,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: - - *466 - - *467 + - *469 + - *470 - *71 requestBody: required: true @@ -63242,11 +63733,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: - '200': *287 + '200': *291 '404': *6 x-github: githubCloudOnly: false @@ -63273,10 +63764,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: - - *466 - - *467 + - *469 + - *470 - *71 - - *288 + - *292 responses: '200': *77 '404': *6 @@ -63304,9 +63795,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: - - *466 - - *467 - - &511 + - *469 + - *470 + - &512 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. @@ -63314,7 +63805,7 @@ paths: required: false schema: type: string - - &512 + - &513 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63322,7 +63813,7 @@ paths: required: false schema: type: string - - &513 + - &514 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63331,7 +63822,7 @@ paths: required: false schema: type: string - - &514 + - &515 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 @@ -63358,7 +63849,7 @@ paths: - pending - *17 - *19 - - &515 + - &516 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)." @@ -63367,7 +63858,7 @@ paths: schema: type: string format: date-time - - &494 + - &495 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63376,13 +63867,13 @@ paths: schema: type: boolean default: false - - &516 + - &517 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &517 + - &518 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63405,7 +63896,7 @@ paths: type: integer workflow_runs: type: array - items: &495 + items: &496 title: Workflow Run description: An invocation of a workflow type: object @@ -63500,7 +63991,7 @@ paths: that triggered the run. type: array nullable: true - items: &536 + items: &537 title: Pull Request Minimal type: object properties: @@ -63619,7 +64110,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &540 + properties: &541 id: type: string description: SHA for the commit @@ -63670,7 +64161,7 @@ paths: - name - email nullable: true - required: &541 + required: &542 - id - tree_id - message @@ -63678,8 +64169,8 @@ paths: - author - committer nullable: true - repository: *280 - head_repository: *280 + repository: *284 + head_repository: *284 head_repository_id: type: integer example: 5 @@ -63717,7 +64208,7 @@ paths: - workflow_url - pull_requests examples: - default: &518 + default: &519 value: total_count: 1 workflow_runs: @@ -63953,24 +64444,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *466 - - *467 - - &496 + - *469 + - *470 + - &497 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *494 + - *495 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: &499 + default: &500 value: id: 30433642 name: Build @@ -64211,9 +64702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '204': description: Response @@ -64236,9 +64727,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -64357,15 +64848,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64392,12 +64883,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 - *17 - *19 - - *497 + - *498 responses: '200': description: Response @@ -64413,9 +64904,9 @@ paths: type: integer artifacts: type: array - items: *483 + items: *484 examples: - default: *498 + default: *499 headers: Link: *43 x-github: @@ -64439,25 +64930,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *466 - - *467 - - *496 - - &500 + - *469 + - *470 + - *497 + - &501 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *494 + - *495 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64480,10 +64971,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: - - *466 - - *467 - - *496 - - *500 + - *469 + - *470 + - *497 + - *501 - *17 - *19 responses: @@ -64501,9 +64992,9 @@ paths: type: integer jobs: type: array - items: *501 + items: *502 examples: - default: &502 + default: &503 value: total_count: 1 jobs: @@ -64616,10 +65107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *466 - - *467 - - *496 - - *500 + - *469 + - *470 + - *497 + - *501 responses: '302': description: Response @@ -64647,15 +65138,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '202': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64682,9 +65173,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: true content: @@ -64751,15 +65242,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '202': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64786,9 +65277,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 - 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 @@ -64818,9 +65309,9 @@ paths: type: integer jobs: type: array - items: *501 + items: *502 examples: - default: *502 + default: *503 headers: Link: *43 x-github: @@ -64845,9 +65336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '302': description: Response @@ -64874,9 +65365,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '204': description: Response @@ -64903,9 +65394,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -64965,7 +65456,7 @@ paths: items: type: object properties: - type: &625 + type: &626 type: string description: The type of reviewer. enum: @@ -64975,7 +65466,7 @@ paths: reviewer: anyOf: - *4 - - *307 + - *311 required: - environment - wait_timer @@ -65050,9 +65541,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: true content: @@ -65099,7 +65590,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65187,8 +65678,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -65205,7 +65696,7 @@ paths: - created_at - updated_at examples: - default: &612 + default: &613 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65261,9 +65752,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: false content: @@ -65284,7 +65775,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65307,9 +65798,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: false content: @@ -65330,7 +65821,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65363,9 +65854,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -65502,8 +65993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -65521,9 +66012,9 @@ paths: type: integer secrets: type: array - items: *503 + items: *504 examples: - default: *504 + default: *505 headers: Link: *43 x-github: @@ -65548,16 +66039,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *505 + schema: *506 examples: - default: *506 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65579,17 +66070,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: &638 + default: &639 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65615,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -65648,7 +66139,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65674,9 +66165,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -65701,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *466 - - *467 - - *490 + - *469 + - *470 + - *491 - *19 responses: '200': @@ -65720,9 +66211,9 @@ paths: type: integer variables: type: array - items: *507 + items: *508 examples: - default: *508 + default: *509 headers: Link: *43 x-github: @@ -65745,8 +66236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -65773,7 +66264,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65798,17 +66289,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &639 + default: &640 value: name: USERNAME value: octocat @@ -65834,9 +66325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 requestBody: required: true content: @@ -65878,9 +66369,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 responses: '204': description: Response @@ -65905,8 +66396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -65924,7 +66415,7 @@ paths: type: integer workflows: type: array - items: &509 + items: &510 title: Workflow description: A GitHub Actions workflow type: object @@ -66031,9 +66522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *466 - - *467 - - &510 + - *469 + - *470 + - &511 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66048,7 +66539,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *510 examples: default: value: @@ -66081,9 +66572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66108,9 +66599,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66161,9 +66652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66190,19 +66681,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: - - *466 - - *467 - - *510 + - *469 + - *470 - *511 - *512 - *513 - *514 + - *515 - *17 - *19 - - *515 - - *494 - *516 + - *495 - *517 + - *518 responses: '200': description: Response @@ -66218,9 +66709,9 @@ paths: type: integer workflow_runs: type: array - items: *495 + items: *496 examples: - default: *518 + default: *519 headers: Link: *43 x-github: @@ -66253,9 +66744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '200': description: Response @@ -66316,8 +66807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *466 - - *467 + - *469 + - *470 - *106 - *17 - *104 @@ -66481,8 +66972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -66494,7 +66985,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -66519,8 +67010,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: - - *466 - - *467 + - *469 + - *470 - name: assignee in: path required: true @@ -66556,8 +67047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -66669,8 +67160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *104 - *105 @@ -66727,7 +67218,7 @@ paths: initiator: type: string examples: - default: *519 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66747,8 +67238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -66756,7 +67247,7 @@ paths: application/json: schema: type: array - items: &520 + items: &521 title: Autolink reference description: An autolink reference. type: object @@ -66810,8 +67301,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -66850,9 +67341,9 @@ paths: description: response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: id: 1 key_prefix: TICKET- @@ -66883,9 +67374,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: - - *466 - - *467 - - &522 + - *469 + - *470 + - &523 name: autolink_id description: The unique identifier of the autolink. in: path @@ -66897,9 +67388,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 '404': *6 x-github: githubCloudOnly: false @@ -66919,9 +67410,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: - - *466 - - *467 - - *522 + - *469 + - *470 + - *523 responses: '204': description: Response @@ -66945,8 +67436,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response if Dependabot is enabled @@ -66994,8 +67485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -67016,8 +67507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -67037,8 +67528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *466 - - *467 + - *469 + - *470 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67076,7 +67567,7 @@ paths: - url protected: type: boolean - protection: &524 + protection: &525 title: Branch Protection description: Branch Protection type: object @@ -67118,7 +67609,7 @@ paths: required: - contexts - checks - enforce_admins: &527 + enforce_admins: &528 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67133,7 +67624,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &529 + required_pull_request_reviews: &530 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67154,7 +67645,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *307 + items: *311 apps: description: The list of apps with review dismissal access. @@ -67183,7 +67674,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *307 + items: *311 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67209,7 +67700,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &526 + restrictions: &527 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67272,7 +67763,7 @@ paths: type: string teams: type: array - items: *307 + items: *311 apps: type: array items: @@ -67486,9 +67977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *466 - - *467 - - &525 + - *469 + - *470 + - &526 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). @@ -67502,14 +67993,14 @@ paths: description: Response content: application/json: - schema: &535 + schema: &536 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &585 + commit: &586 title: Commit description: Commit type: object @@ -67543,7 +68034,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &523 + properties: &524 name: type: string example: '"Chris Wanstrath"' @@ -67558,7 +68049,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true message: type: string @@ -67579,7 +68070,7 @@ paths: required: - sha - url - verification: &645 + verification: &646 title: Verification type: object properties: @@ -67613,12 +68104,12 @@ paths: nullable: true oneOf: - *4 - - *291 + - *295 committer: nullable: true oneOf: - *4 - - *291 + - *295 parents: type: array items: @@ -67649,7 +68140,7 @@ paths: type: integer files: type: array - items: &598 + items: &599 title: Diff Entry description: Diff Entry type: object @@ -67733,7 +68224,7 @@ paths: - self protected: type: boolean - protection: *524 + protection: *525 protection_url: type: string format: uri @@ -67840,7 +68331,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *480 + '301': *481 '404': *6 x-github: githubCloudOnly: false @@ -67862,15 +68353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *524 + schema: *525 examples: default: value: @@ -68064,9 +68555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -68321,7 +68812,7 @@ paths: url: type: string format: uri - required_status_checks: &532 + required_status_checks: &533 title: Status Check Policy description: Status Check Policy type: object @@ -68397,7 +68888,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 apps: type: array items: *5 @@ -68415,7 +68906,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 apps: type: array items: *5 @@ -68473,7 +68964,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *526 + restrictions: *527 required_conversation_resolution: type: object properties: @@ -68585,9 +69076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68612,17 +69103,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: &528 + default: &529 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68644,17 +69135,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: *528 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68673,9 +69164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68700,17 +69191,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: &530 + default: &531 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68806,9 +69297,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -68906,9 +69397,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: *530 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68929,9 +69420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68958,17 +69449,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: &531 + default: &532 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -68991,17 +69482,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: *531 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -69021,9 +69512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69048,17 +69539,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: &533 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69084,9 +69575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69138,9 +69629,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: *533 + default: *534 '404': *6 '422': *15 x-github: @@ -69162,9 +69653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69188,9 +69679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69224,9 +69715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69293,9 +69784,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69359,9 +69850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: content: application/json: @@ -69427,15 +69918,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *527 examples: default: value: @@ -69526,9 +70017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69551,9 +70042,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69563,7 +70054,7 @@ paths: type: array items: *5 examples: - default: &534 + default: &535 value: - id: 1 slug: octoapp @@ -69620,9 +70111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69656,7 +70147,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69677,9 +70168,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69713,7 +70204,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69734,9 +70225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69770,7 +70261,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69792,9 +70283,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69802,9 +70293,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '404': *6 x-github: githubCloudOnly: false @@ -69824,9 +70315,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69862,9 +70353,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -69885,9 +70376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69923,9 +70414,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -69946,9 +70437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: content: application/json: @@ -69983,9 +70474,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -70007,9 +70498,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -70019,7 +70510,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '404': *6 x-github: githubCloudOnly: false @@ -70043,9 +70534,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70078,7 +70569,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70103,9 +70594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70138,7 +70629,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70163,9 +70654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70198,7 +70689,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70225,9 +70716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70249,7 +70740,7 @@ paths: description: Response content: application/json: - schema: *535 + schema: *536 examples: default: value: @@ -70363,8 +70854,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 @@ -70378,9 +70869,9 @@ paths: application/json: schema: type: array - items: *302 + items: *306 examples: - default: *303 + default: *307 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70400,8 +70891,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70415,7 +70906,7 @@ paths: description: Response content: application/json: - schema: *302 + schema: *306 examples: default: value: @@ -70474,8 +70965,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 @@ -70489,9 +70980,9 @@ paths: application/json: schema: type: array - items: *305 + items: *309 examples: - default: *306 + default: *310 '404': *6 '403': *29 '500': *40 @@ -70515,8 +71006,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70528,7 +71019,7 @@ paths: description: A single bypass request. content: application/json: - schema: *305 + schema: *309 examples: default: value: @@ -70586,8 +71077,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70658,8 +71149,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_response_id in: path required: true @@ -70692,8 +71183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -70972,7 +71463,7 @@ paths: description: Response content: application/json: - schema: &537 + schema: &538 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71083,16 +71574,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *536 - deployment: &868 + items: *537 + deployment: &870 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71159,8 +71650,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -71372,9 +71863,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *466 - - *467 - - &538 + - *469 + - *470 + - &539 name: check_run_id description: The unique identifier of the check run. in: path @@ -71386,9 +71877,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *538 examples: - default: &539 + default: &540 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71488,9 +71979,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 requestBody: required: true content: @@ -71730,9 +72221,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *538 examples: - default: *539 + default: *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71752,9 +72243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 - *17 - *19 responses: @@ -71849,15 +72340,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -71895,8 +72386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -71918,7 +72409,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &542 + schema: &543 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -71982,7 +72473,7 @@ paths: nullable: true pull_requests: type: array - items: *536 + items: *537 nullable: true app: title: GitHub app @@ -71993,9 +72484,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - repository: *280 + properties: *212 + required: *213 + repository: *284 created_at: type: string format: date-time @@ -72004,12 +72495,12 @@ paths: type: string format: date-time nullable: true - head_commit: &894 + head_commit: &896 title: Simple Commit description: A commit. type: object - properties: *540 - required: *541 + properties: *541 + required: *542 latest_check_runs_count: type: integer check_runs_url: @@ -72037,7 +72528,7 @@ paths: - check_runs_url - pull_requests examples: - default: &543 + default: &544 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72328,9 +72819,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *542 + schema: *543 examples: - default: *543 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72349,8 +72840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -72411,7 +72902,7 @@ paths: required: - app_id - setting - repository: *280 + repository: *284 examples: default: value: @@ -72659,9 +73150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *466 - - *467 - - &544 + - *469 + - *470 + - &545 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72673,9 +73164,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *543 examples: - default: *543 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72698,17 +73189,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: - - *466 - - *467 - - *544 - - &591 + - *469 + - *470 + - *545 + - &592 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &592 + - &593 name: status description: Returns check runs with the specified `status`. in: query @@ -72747,9 +73238,9 @@ paths: type: integer check_runs: type: array - items: *537 + items: *538 examples: - default: &593 + default: &594 value: total_count: 1 check_runs: @@ -72851,15 +73342,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *466 - - *467 - - *544 + - *469 + - *470 + - *545 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -72886,21 +73377,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: - - *466 - - *467 - - *311 - - *312 + - *469 + - *470 + - *315 + - *316 - *19 - *17 - - &560 + - &561 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: *545 - - &561 + schema: *546 + - &562 name: pr description: The number of the pull request for the results you want to list. in: query @@ -72925,13 +73416,13 @@ paths: be returned. in: query required: false - schema: *313 + schema: *317 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *546 + schema: *547 responses: '200': description: Response @@ -72947,7 +73438,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *547 + instances_url: *548 state: *109 fixed_at: *133 dismissed_by: @@ -72958,11 +73449,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *548 - dismissed_comment: *549 - rule: *550 - tool: *551 - most_recent_instance: *552 + dismissed_reason: *549 + dismissed_comment: *550 + rule: *551 + tool: *552 + most_recent_instance: *553 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73088,7 +73579,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &553 + '403': &554 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73115,9 +73606,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: - - *466 - - *467 - - &554 + - *469 + - *470 + - &555 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73131,7 +73622,7 @@ paths: description: Response content: application/json: - schema: &555 + schema: &556 type: object properties: number: *123 @@ -73139,7 +73630,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *547 + instances_url: *548 state: *109 fixed_at: *133 dismissed_by: @@ -73150,8 +73641,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *548 - dismissed_comment: *549 + dismissed_reason: *549 + dismissed_comment: *550 rule: type: object properties: @@ -73205,8 +73696,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *551 - most_recent_instance: *552 + tool: *552 + most_recent_instance: *553 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73305,7 +73796,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73325,9 +73816,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: true content: @@ -73342,8 +73833,8 @@ paths: enum: - open - dismissed - dismissed_reason: *548 - dismissed_comment: *549 + dismissed_reason: *549 + dismissed_comment: *550 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73362,7 +73853,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *556 examples: default: value: @@ -73438,7 +73929,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &559 + '403': &560 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73465,15 +73956,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 responses: '200': description: Response content: application/json: - schema: &556 + schema: &557 type: object properties: status: @@ -73499,13 +73990,13 @@ paths: - description - started_at examples: - default: &557 + default: &558 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &558 + '400': &559 description: Bad Request content: application/json: @@ -73516,7 +74007,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': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73541,29 +74032,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 responses: '200': description: OK content: application/json: - schema: *556 + schema: *557 examples: - default: *557 + default: *558 '202': description: Accepted content: application/json: - schema: *556 + schema: *557 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *558 + '400': *559 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73595,9 +74086,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: false content: @@ -73642,8 +74133,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *558 - '403': *559 + '400': *559 + '403': *560 '404': *6 '422': description: Unprocessable Entity @@ -73667,13 +74158,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 - *19 - *17 - - *560 - *561 + - *562 responses: '200': description: Response @@ -73681,7 +74172,7 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: default: value: @@ -73720,7 +74211,7 @@ paths: end_column: 50 classifications: - source - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73754,25 +74245,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: - - *466 - - *467 - - *311 - - *312 + - *469 + - *470 + - *315 + - *316 - *19 - *17 - - *561 + - *562 - 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: *545 + schema: *546 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &564 + schema: &565 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73793,23 +74284,23 @@ paths: application/json: schema: type: array - items: &565 + items: &566 type: object properties: - ref: *545 - commit_sha: &573 + ref: *546 + commit_sha: &574 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: *562 + analysis_key: *563 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *563 + category: *564 error: type: string example: error reading field xyz @@ -73833,8 +74324,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *564 - tool: *551 + sarif_id: *565 + tool: *552 deletable: type: boolean warning: @@ -73895,7 +74386,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73931,8 +74422,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: - - *466 - - *467 + - *469 + - *470 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -73945,7 +74436,7 @@ paths: description: Response content: application/json: - schema: *565 + schema: *566 examples: response: summary: application/json response @@ -73999,7 +74490,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *553 + '403': *554 '404': *6 '422': description: Response if analysis could not be processed @@ -74086,8 +74577,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: - - *466 - - *467 + - *469 + - *470 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74140,7 +74631,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': *559 + '403': *560 '404': *6 '503': *190 x-github: @@ -74162,8 +74653,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -74171,7 +74662,7 @@ paths: application/json: schema: type: array - items: &566 + items: &567 title: CodeQL Database description: A CodeQL database. type: object @@ -74282,7 +74773,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': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -74311,8 +74802,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: - - *466 - - *467 + - *469 + - *470 - name: language in: path description: The language of the CodeQL database. @@ -74324,7 +74815,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -74356,9 +74847,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': &600 + '302': &601 description: Found - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -74380,8 +74871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *466 - - *467 + - *469 + - *470 - name: language in: path description: The language of the CodeQL database. @@ -74391,7 +74882,7 @@ paths: responses: '204': description: Response - '403': *559 + '403': *560 '404': *6 '503': *190 x-github: @@ -74419,8 +74910,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -74429,7 +74920,7 @@ paths: type: object additionalProperties: false properties: - language: &567 + language: &568 type: string description: The language targeted by the CodeQL query enum: @@ -74508,7 +74999,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &571 + schema: &572 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74518,7 +75009,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *567 + query_language: *568 query_pack_url: type: string description: The download url for the query pack. @@ -74565,7 +75056,7 @@ paths: items: type: object properties: - repository: &568 + repository: &569 title: Repository Identifier description: Repository Identifier type: object @@ -74601,7 +75092,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &572 + analysis_status: &573 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74633,7 +75124,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &569 + access_mismatch_repos: &570 type: object properties: repository_count: @@ -74647,7 +75138,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: *568 + items: *569 required: - repository_count - repositories @@ -74669,8 +75160,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *569 - over_limit_repos: *569 + no_codeql_db_repos: *570 + over_limit_repos: *570 required: - access_mismatch_repos - not_found_repos @@ -74686,7 +75177,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &570 + value: &571 summary: Default response value: id: 1 @@ -74838,10 +75329,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *570 + value: *571 repository_lists: summary: Response for a successful variant analysis submission - value: *570 + value: *571 '404': *6 '422': description: Unable to process variant analysis submission @@ -74869,8 +75360,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: - - *466 - - *467 + - *469 + - *470 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -74882,9 +75373,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *572 examples: - default: *570 + default: *571 '404': *6 '503': *190 x-github: @@ -74907,7 +75398,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: - - *466 + - *469 - name: repo in: path description: The name of the controller repository. @@ -74942,7 +75433,7 @@ paths: type: object properties: repository: *115 - analysis_status: *572 + analysis_status: *573 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75067,8 +75558,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75153,7 +75644,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -75174,8 +75665,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -75242,7 +75733,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -75267,7 +75758,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *559 + '403': *560 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75338,8 +75829,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -75347,7 +75838,7 @@ paths: schema: type: object properties: - commit_sha: *573 + commit_sha: *574 ref: type: string description: |- @@ -75405,7 +75896,7 @@ paths: schema: type: object properties: - id: *564 + id: *565 url: type: string description: The REST API URL for checking the status of the upload. @@ -75419,7 +75910,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': *559 + '403': *560 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75442,8 +75933,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: - - *466 - - *467 + - *469 + - *470 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75489,7 +75980,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': *553 + '403': *554 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75514,8 +76005,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75596,8 +76087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *466 - - *467 + - *469 + - *470 - 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 @@ -75717,8 +76208,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75734,7 +76225,7 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: default: value: @@ -76032,8 +76523,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -76096,17 +76587,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '400': *14 '401': *25 '403': *29 @@ -76135,8 +76626,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -76200,8 +76691,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: - - *466 - - *467 + - *469 + - *470 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76236,14 +76727,14 @@ paths: type: integer machines: type: array - items: &819 + items: &821 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *575 - required: *576 + properties: *576 + required: *577 examples: - default: &820 + default: &822 value: total_count: 2 machines: @@ -76283,8 +76774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *466 - - *467 + - *469 + - *470 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76368,8 +76859,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: - - *466 - - *467 + - *469 + - *470 - 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 @@ -76435,8 +76926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -76454,7 +76945,7 @@ paths: type: integer secrets: type: array - items: &580 + items: &581 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76474,7 +76965,7 @@ paths: - created_at - updated_at examples: - default: *577 + default: *578 headers: Link: *43 x-github: @@ -76497,16 +76988,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *578 + schema: *579 examples: - default: *579 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76526,17 +77017,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: *581 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76556,9 +77047,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: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -76586,7 +77077,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -76610,9 +77101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -76640,8 +77131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *466 - - *467 + - *469 + - *470 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76683,7 +77174,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &582 + properties: &583 login: type: string example: octocat @@ -76776,7 +77267,7 @@ paths: user_view_type: type: string example: public - required: &583 + required: &584 - avatar_url - events_url - followers_url @@ -76850,8 +77341,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: - - *466 - - *467 + - *469 + - *470 - *138 responses: '204': @@ -76898,8 +77389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *466 - - *467 + - *469 + - *470 - *138 requestBody: required: false @@ -76926,7 +77417,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &658 + schema: &659 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -76937,7 +77428,7 @@ paths: example: 42 type: integer format: int64 - repository: *280 + repository: *284 invitee: title: Simple User description: A GitHub user. @@ -77115,7 +77606,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *255 + schema: *259 '403': *29 x-github: triggersNotification: true @@ -77155,8 +77646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *466 - - *467 + - *469 + - *470 - *138 responses: '204': @@ -77188,8 +77679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *466 - - *467 + - *469 + - *470 - *138 responses: '200': @@ -77210,8 +77701,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *582 - required: *583 + properties: *583 + required: *584 nullable: true required: - permission @@ -77266,8 +77757,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -77277,7 +77768,7 @@ paths: application/json: schema: type: array - items: &584 + items: &585 title: Commit Comment description: Commit Comment type: object @@ -77318,8 +77809,8 @@ paths: updated_at: type: string format: date-time - author_association: *213 - reactions: *214 + author_association: *214 + reactions: *215 required: - url - html_url @@ -77335,7 +77826,7 @@ paths: - created_at - updated_at examples: - default: &587 + default: &588 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77394,17 +77885,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: &588 + default: &589 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77461,9 +77952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -77485,7 +77976,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *585 examples: default: value: @@ -77536,9 +78027,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -77559,9 +78050,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -77587,9 +78078,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -77610,9 +78101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -77644,16 +78135,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -77675,10 +78166,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -77727,8 +78218,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *466 - - *467 + - *469 + - *470 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77784,9 +78275,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: &710 + default: &712 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77880,9 +78371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *466 - - *467 - - &586 + - *469 + - *470 + - &587 name: commit_sha description: The SHA of the commit. in: path @@ -77954,9 +78445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 - *17 - *19 responses: @@ -77966,9 +78457,9 @@ paths: application/json: schema: type: array - items: *584 + items: *585 examples: - default: *587 + default: *588 headers: Link: *43 x-github: @@ -77996,9 +78487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 requestBody: required: true content: @@ -78033,9 +78524,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: *588 + default: *589 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78063,9 +78554,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: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 - *17 - *19 responses: @@ -78075,9 +78566,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: &702 + default: &704 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78614,11 +79105,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 - - &590 + - &591 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)" @@ -78633,9 +79124,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *586 examples: - default: &687 + default: &689 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78748,11 +79239,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: - - *466 - - *467 - - *590 + - *469 + - *470 - *591 - *592 + - *593 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78786,9 +79277,9 @@ paths: type: integer check_runs: type: array - items: *537 + items: *538 examples: - default: *593 + default: *594 headers: Link: *43 x-github: @@ -78813,9 +79304,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: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78823,7 +79314,7 @@ paths: schema: type: integer example: 1 - - *591 + - *592 - *17 - *19 responses: @@ -78841,7 +79332,7 @@ paths: type: integer check_suites: type: array - items: *542 + items: *543 examples: default: value: @@ -79041,9 +79532,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: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - *17 - *19 responses: @@ -79110,7 +79601,7 @@ paths: type: string total_count: type: integer - repository: *280 + repository: *284 commit_url: type: string format: uri @@ -79241,9 +79732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - *17 - *19 responses: @@ -79253,7 +79744,7 @@ paths: application/json: schema: type: array - items: &764 + items: &766 title: Status description: The status of a commit. type: object @@ -79334,7 +79825,7 @@ paths: site_admin: false headers: Link: *43 - '301': *480 + '301': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79362,8 +79853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -79392,20 +79883,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *594 - required: *595 + properties: *595 + required: *596 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &596 + properties: &597 url: type: string format: uri html_url: type: string format: uri - required: &597 + required: &598 - url - html_url nullable: true @@ -79413,32 +79904,32 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true contributing: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true readme: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true issue_template: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true pull_request_template: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true required: - code_of_conduct @@ -79565,8 +80056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 - name: basehead @@ -79609,8 +80100,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *585 - merge_base_commit: *585 + base_commit: *586 + merge_base_commit: *586 status: type: string enum: @@ -79630,10 +80121,10 @@ paths: example: 6 commits: type: array - items: *585 + items: *586 files: type: array - items: *598 + items: *599 required: - url - html_url @@ -79919,8 +80410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80063,7 +80554,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &599 + response-if-content-is-a-file: &600 summary: Response if content is a file value: type: file @@ -80195,7 +80686,7 @@ paths: - size - type - url - - &715 + - &717 title: Content File description: Content File type: object @@ -80396,7 +80887,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *599 + response-if-content-is-a-file: *600 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80465,7 +80956,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *600 + '302': *601 '304': *37 x-github: githubCloudOnly: false @@ -80488,8 +80979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80582,7 +81073,7 @@ paths: description: Response content: application/json: - schema: &601 + schema: &602 title: File Commit description: File Commit type: object @@ -80734,7 +81225,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: example-for-creating-a-file: value: @@ -80788,7 +81279,7 @@ paths: schema: oneOf: - *3 - - &640 + - &641 description: Repository rule violation was detected type: object properties: @@ -80809,7 +81300,7 @@ paths: items: type: object properties: - placeholder_id: &756 + placeholder_id: &758 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80841,8 +81332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80903,7 +81394,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: default: value: @@ -80958,8 +81449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *466 - - *467 + - *469 + - *470 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81082,22 +81573,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *466 - - *467 - - *327 - - *328 - - *329 - - *330 + - *469 + - *470 + - *331 + - *332 + - *333 + - *334 - 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 - - *331 - - *602 - - *332 - - *333 + - *335 + - *603 + - *336 + - *337 - *106 - name: per_page description: The number of results per page (max 100). For more information, @@ -81116,7 +81607,7 @@ paths: application/json: schema: type: array - items: &605 + items: &606 type: object description: A Dependabot alert. properties: @@ -81162,7 +81653,7 @@ paths: - unknown - direct - transitive - security_advisory: *603 + security_advisory: *604 security_vulnerability: *127 url: *128 html_url: *129 @@ -81193,7 +81684,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *604 + auto_dismissed_at: *605 required: - number - state @@ -81423,9 +81914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *466 - - *467 - - &606 + - *469 + - *470 + - &607 name: alert_number in: path description: |- @@ -81440,7 +81931,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -81553,9 +82044,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *466 - - *467 - - *606 + - *469 + - *470 + - *607 requestBody: required: true content: @@ -81600,7 +82091,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -81729,8 +82220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -81748,7 +82239,7 @@ paths: type: integer secrets: type: array - items: &609 + items: &610 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81801,16 +82292,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: *608 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81830,15 +82321,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *609 + schema: *610 examples: default: value: @@ -81864,9 +82355,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -81894,7 +82385,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -81918,9 +82409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -81942,8 +82433,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: - - *466 - - *467 + - *469 + - *470 - 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 @@ -82103,8 +82594,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -82343,8 +82834,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -82419,7 +82910,7 @@ paths: - version - url additionalProperties: false - metadata: &610 + metadata: &611 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82452,7 +82943,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *610 + metadata: *611 resolved: type: object description: A collection of resolved package dependencies. @@ -82465,7 +82956,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *610 + metadata: *611 relationship: type: string description: A notation of whether a dependency is requested @@ -82594,8 +83085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *466 - - *467 + - *469 + - *470 - name: sha description: The SHA recorded at creation time. in: query @@ -82635,9 +83126,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 headers: Link: *43 x-github: @@ -82703,8 +83194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -82785,7 +83276,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: simple-example: summary: Simple example @@ -82858,9 +83349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *466 - - *467 - - &613 + - *469 + - *470 + - &614 name: deployment_id description: deployment_id parameter in: path @@ -82872,7 +83363,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -82937,9 +83428,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 responses: '204': description: Response @@ -82961,9 +83452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 - *17 - *19 responses: @@ -82973,7 +83464,7 @@ paths: application/json: schema: type: array - items: &614 + items: &615 title: Deployment Status description: The status of a deployment. type: object @@ -83064,8 +83555,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -83134,9 +83625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 requestBody: required: true content: @@ -83211,9 +83702,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &615 + default: &616 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83269,9 +83760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 - name: status_id in: path required: true @@ -83282,9 +83773,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -83311,12 +83802,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 - - *616 + - *469 + - *470 - *617 - *618 - *619 + - *620 - *17 - *19 responses: @@ -83326,9 +83817,9 @@ paths: application/json: schema: type: array - items: *620 + items: *621 examples: - default: *621 + default: *622 '404': *6 '403': *29 '500': *40 @@ -83352,8 +83843,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83365,7 +83856,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *620 + schema: *621 examples: default: value: @@ -83421,8 +83912,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83481,12 +83972,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 - - *622 + - *623 - *17 - *19 responses: @@ -83496,9 +83987,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: *624 + default: *625 '404': *6 '403': *29 '500': *40 @@ -83523,8 +84014,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83536,7 +84027,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *623 + schema: *624 examples: default: value: @@ -83594,8 +84085,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83664,8 +84155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -83722,8 +84213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -83740,7 +84231,7 @@ paths: type: integer environments: type: array - items: &626 + items: &627 title: Environment description: Details of a deployment environment type: object @@ -83792,7 +84283,7 @@ paths: type: type: string example: wait_timer - wait_timer: &628 + wait_timer: &629 type: integer example: 30 description: The amount of time to delay a job after @@ -83829,11 +84320,11 @@ paths: items: type: object properties: - type: *625 + type: *626 reviewer: anyOf: - *4 - - *307 + - *311 required: - id - node_id @@ -83853,7 +84344,7 @@ paths: - id - node_id - type - deployment_branch_policy: &629 + deployment_branch_policy: &630 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -83969,9 +84460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *466 - - *467 - - &627 + - *469 + - *470 + - &628 name: environment_name in: path required: true @@ -83984,9 +84475,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: &630 + default: &631 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84070,9 +84561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: false content: @@ -84081,7 +84572,7 @@ paths: type: object nullable: true properties: - wait_timer: *628 + wait_timer: *629 prevent_self_review: type: boolean example: false @@ -84098,13 +84589,13 @@ paths: items: type: object properties: - type: *625 + type: *626 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *629 + deployment_branch_policy: *630 additionalProperties: false examples: default: @@ -84124,9 +84615,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *630 + default: *631 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84150,9 +84641,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 responses: '204': description: Default response @@ -84177,9 +84668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 - *17 - *19 responses: @@ -84197,7 +84688,7 @@ paths: example: 2 branch_policies: type: array - items: &631 + items: &632 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84254,9 +84745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: true content: @@ -84302,9 +84793,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - example-wildcard: &632 + example-wildcard: &633 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84346,10 +84837,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - &633 + - *469 + - *470 + - *628 + - &634 name: branch_policy_id in: path required: true @@ -84361,9 +84852,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84382,10 +84873,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - *633 + - *469 + - *470 + - *628 + - *634 requestBody: required: true content: @@ -84413,9 +84904,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84434,10 +84925,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - *633 + - *469 + - *470 + - *628 + - *634 responses: '204': description: Response @@ -84462,9 +84953,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 responses: '200': description: List of deployment protection rules @@ -84480,7 +84971,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &634 + items: &635 title: Deployment protection rule description: Deployment protection rule type: object @@ -84499,7 +84990,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &635 + app: &636 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84598,9 +85089,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 requestBody: content: application/json: @@ -84621,9 +85112,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *634 + schema: *635 examples: - default: &636 + default: &637 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84658,9 +85149,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 - *19 - *17 responses: @@ -84679,7 +85170,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *635 + items: *636 examples: default: value: @@ -84714,10 +85205,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: - - *466 - - *467 - - *627 - - &637 + - *469 + - *470 + - *628 + - &638 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84729,9 +85220,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *636 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84752,10 +85243,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: - - *627 - - *467 - - *466 - - *637 + - *628 + - *470 + - *469 + - *638 responses: '204': description: Response @@ -84781,9 +85272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 - *17 - *19 responses: @@ -84801,9 +85292,9 @@ paths: type: integer secrets: type: array - items: *503 + items: *504 examples: - default: *504 + default: *505 headers: Link: *43 x-github: @@ -84828,17 +85319,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 responses: '200': description: Response content: application/json: - schema: *505 + schema: *506 examples: - default: *506 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84860,18 +85351,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 responses: '200': description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: *638 + default: *639 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84893,10 +85384,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 requestBody: required: true content: @@ -84927,7 +85418,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -84953,10 +85444,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 responses: '204': description: Default response @@ -84981,10 +85472,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *466 - - *467 - - *627 - - *490 + - *469 + - *470 + - *628 + - *491 - *19 responses: '200': @@ -85001,9 +85492,9 @@ paths: type: integer variables: type: array - items: *507 + items: *508 examples: - default: *508 + default: *509 headers: Link: *43 x-github: @@ -85026,9 +85517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: true content: @@ -85055,7 +85546,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -85080,18 +85571,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *466 - - *467 - - *627 - - *293 + - *469 + - *470 + - *628 + - *297 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *639 + default: *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85112,10 +85603,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *466 - - *467 - - *293 - - *627 + - *469 + - *470 + - *297 + - *628 requestBody: required: true content: @@ -85157,10 +85648,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *466 - - *467 - - *293 - - *627 + - *469 + - *470 + - *297 + - *628 responses: '204': description: Response @@ -85182,8 +85673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -85193,7 +85684,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: 200-response: value: @@ -85251,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *466 - - *467 + - *469 + - *470 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85274,7 +85765,7 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: default: value: @@ -85411,8 +85902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -85444,9 +85935,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 '400': *14 '422': *15 '403': *29 @@ -85467,8 +85958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -85527,8 +86018,8 @@ paths: application/json: schema: oneOf: - - *255 - - *640 + - *259 + - *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85553,8 +86044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *466 - - *467 + - *469 + - *470 - name: file_sha in: path required: true @@ -85653,8 +86144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -85763,7 +86254,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &642 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -85977,15 +86468,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 responses: '200': description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -86041,9 +86532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *466 - - *467 - - &642 + - *469 + - *470 + - &643 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. @@ -86060,7 +86551,7 @@ paths: application/json: schema: type: array - items: &643 + items: &644 title: Git Reference description: Git references within a repository type: object @@ -86135,17 +86626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 responses: '200': description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: &644 + default: &645 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86174,8 +86665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86204,9 +86695,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86232,9 +86723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 requestBody: required: true content: @@ -86263,9 +86754,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '422': *15 '409': *114 x-github: @@ -86283,9 +86774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 responses: '204': description: Response @@ -86340,8 +86831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86408,7 +86899,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &647 title: Git Tag description: Metadata for a Git tag type: object @@ -86459,7 +86950,7 @@ paths: - sha - type - url - verification: *645 + verification: *646 required: - sha - url @@ -86469,7 +86960,7 @@ paths: - tag - message examples: - default: &647 + default: &648 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86542,8 +87033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *466 - - *467 + - *469 + - *470 - name: tag_sha in: path required: true @@ -86554,9 +87045,9 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: - default: *647 + default: *648 '404': *6 '409': *114 x-github: @@ -86580,8 +87071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86654,7 +87145,7 @@ paths: description: Response content: application/json: - schema: &648 + schema: &649 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86750,8 +87241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *466 - - *467 + - *469 + - *470 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86774,7 +87265,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default-response: summary: Default response @@ -86833,8 +87324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -86844,7 +87335,7 @@ paths: application/json: schema: type: array - items: &649 + items: &650 title: Webhook description: Webhooks for repositories. type: object @@ -86898,7 +87389,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &902 + last_response: &904 title: Hook Response type: object properties: @@ -86972,8 +87463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -87025,9 +87516,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: &650 + default: &651 value: type: Repository id: 12345678 @@ -87075,17 +87566,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '200': description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '404': *6 x-github: githubCloudOnly: false @@ -87105,9 +87596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 requestBody: required: true content: @@ -87152,9 +87643,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '422': *15 '404': *6 x-github: @@ -87175,9 +87666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87201,9 +87692,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '200': description: Response @@ -87230,9 +87721,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 requestBody: required: false content: @@ -87276,11 +87767,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *17 - - *342 + - *346 responses: '200': description: Response @@ -87288,9 +87779,9 @@ paths: application/json: schema: type: array - items: *343 + items: *347 examples: - default: *344 + default: *348 '400': *14 '422': *15 x-github: @@ -87309,18 +87800,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *16 responses: '200': description: Response content: application/json: - schema: *345 + schema: *349 examples: - default: *346 + default: *350 '400': *14 '422': *15 x-github: @@ -87339,9 +87830,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *16 responses: '202': *39 @@ -87364,9 +87855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87391,9 +87882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87416,8 +87907,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response if immutable releases are enabled @@ -87463,8 +87954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '409': *114 @@ -87484,8 +87975,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '409': *114 @@ -87542,14 +88033,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &651 + schema: &652 title: Import description: A repository import from an external source. type: object @@ -87648,7 +88139,7 @@ paths: - html_url - authors_url examples: - default: &654 + default: &655 value: vcs: subversion use_lfs: true @@ -87664,7 +88155,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': &652 + '503': &653 description: Unavailable due to service under maintenance. content: application/json: @@ -87693,8 +88184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -87742,7 +88233,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: default: value: @@ -87767,7 +88258,7 @@ paths: type: string '422': *15 '404': *6 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87795,8 +88286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -87845,7 +88336,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: example-1: summary: Example 1 @@ -87893,7 +88384,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': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87916,12 +88407,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87947,9 +88438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *466 - - *467 - - &841 + - *469 + - *470 + - &843 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -87963,7 +88454,7 @@ paths: application/json: schema: type: array - items: &653 + items: &654 title: Porter Author description: Porter Author type: object @@ -88017,7 +88508,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': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88042,8 +88533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *466 - - *467 + - *469 + - *470 - name: author_id in: path required: true @@ -88073,7 +88564,7 @@ paths: description: Response content: application/json: - schema: *653 + schema: *654 examples: default: value: @@ -88086,7 +88577,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88110,8 +88601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88152,7 +88643,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88180,8 +88671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -88208,11 +88699,11 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: - default: *654 + default: *655 '422': *15 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88235,8 +88726,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88244,8 +88735,8 @@ paths: application/json: schema: *22 examples: - default: *655 - '301': *480 + default: *656 + '301': *481 '404': *6 x-github: githubCloudOnly: false @@ -88265,8 +88756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88274,12 +88765,12 @@ paths: application/json: schema: anyOf: - - *359 + - *363 - type: object properties: {} additionalProperties: false examples: - default: &657 + default: &658 value: limit: collaborators_only origin: repository @@ -88304,13 +88795,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *656 + schema: *657 examples: default: summary: Example request body @@ -88322,9 +88813,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *657 + default: *658 '409': description: Response x-github: @@ -88346,8 +88837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -88370,8 +88861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -88381,9 +88872,9 @@ paths: application/json: schema: type: array - items: *658 + items: *659 examples: - default: &834 + default: &836 value: - id: 1 repository: @@ -88514,9 +89005,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *466 - - *467 - - *363 + - *469 + - *470 + - *367 requestBody: required: false content: @@ -88545,7 +89036,7 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: default: value: @@ -88676,9 +89167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *466 - - *467 - - *363 + - *469 + - *470 + - *367 responses: '204': description: Response @@ -88709,8 +89200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *466 - - *467 + - *469 + - *470 - 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 @@ -88758,7 +89249,7 @@ paths: required: false schema: type: string - - *367 + - *371 - name: sort description: What to sort results by. in: query @@ -88771,7 +89262,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -88781,9 +89272,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: &667 + default: &669 value: - id: 1 node_id: MDU6SXNzdWUx @@ -88931,7 +89422,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *480 + '301': *481 '422': *15 '404': *6 x-github: @@ -88960,8 +89451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -89043,9 +89534,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: &664 + default: &666 value: id: 1 node_id: MDU6SXNzdWUx @@ -89201,7 +89692,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *477 + '410': *660 x-github: triggersNotification: true githubCloudOnly: false @@ -89229,9 +89720,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *466 - - *467 - - *236 + - *469 + - *470 + - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89241,7 +89732,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -89251,9 +89742,9 @@ paths: application/json: schema: type: array - items: *659 + items: *661 examples: - default: &666 + default: &668 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89311,17 +89802,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: &660 + default: &662 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89375,9 +89866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -89399,9 +89890,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: *660 + default: *662 '422': *15 x-github: githubCloudOnly: false @@ -89419,9 +89910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -89441,9 +89932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -89469,9 +89960,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -89492,9 +89983,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -89526,16 +90017,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -89557,10 +90048,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -89580,8 +90071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -89591,7 +90082,7 @@ paths: application/json: schema: type: array - items: &663 + items: &665 title: Issue Event description: Issue Event type: object @@ -89634,8 +90125,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *661 - required: *662 + properties: *663 + required: *664 nullable: true label: title: Issue Event Label @@ -89679,7 +90170,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *307 + requested_team: *311 dismissed_review: title: Issue Event Dismissed Review type: object @@ -89744,7 +90235,7 @@ paths: required: - from - to - author_association: *213 + author_association: *214 lock_reason: type: string nullable: true @@ -89757,8 +90248,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -89942,8 +90433,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *466 - - *467 + - *469 + - *470 - name: event_id in: path required: true @@ -89954,7 +90445,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: default: value: @@ -90147,7 +90638,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *477 + '410': *660 '403': *29 x-github: githubCloudOnly: false @@ -90181,9 +90672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *466 - - *467 - - &665 + - *469 + - *470 + - &667 name: issue_number description: The number that identifies the issue. in: path @@ -90195,12 +90686,12 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '404': *6 - '410': *477 + '410': *660 '304': *37 x-github: githubCloudOnly: false @@ -90225,9 +90716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -90331,15 +90822,15 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 '422': *15 '503': *190 '403': *29 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90357,9 +90848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -90385,9 +90876,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90403,9 +90894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: content: application/json: @@ -90430,9 +90921,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90454,9 +90945,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: assignee in: path required: true @@ -90496,10 +90987,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *466 - - *467 - - *665 - - *216 + - *469 + - *470 + - *667 + - *217 - *17 - *19 responses: @@ -90509,13 +91000,13 @@ paths: application/json: schema: type: array - items: *659 + items: *661 examples: - default: *666 + default: *668 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90544,9 +91035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -90568,16 +91059,16 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: *660 + default: *662 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -90605,9 +91096,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90617,14 +91108,14 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90652,9 +91143,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -90676,17 +91167,17 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *480 + '301': *481 '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -90717,9 +91208,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90731,15 +91222,15 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *477 + '410': *660 x-github: triggersNotification: true githubCloudOnly: false @@ -90765,9 +91256,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90777,14 +91268,14 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90801,9 +91292,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90817,7 +91308,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &670 + - &672 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -90848,8 +91339,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 label: type: object properties: @@ -90871,7 +91362,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &673 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -90902,8 +91393,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 label: type: object properties: @@ -90991,8 +91482,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 assigner: *4 required: @@ -91007,7 +91498,7 @@ paths: - performed_via_github_app - assignee - assigner - - &672 + - &674 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91038,8 +91529,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 milestone: type: object properties: @@ -91058,7 +91549,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &675 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91089,8 +91580,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 milestone: type: object properties: @@ -91109,7 +91600,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &676 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91140,8 +91631,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 rename: type: object properties: @@ -91163,7 +91654,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &675 + - &677 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91194,10 +91685,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 review_requester: *4 - requested_team: *307 + requested_team: *311 requested_reviewer: *4 required: - review_requester @@ -91210,7 +91701,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &678 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91241,10 +91732,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 review_requester: *4 - requested_team: *307 + requested_team: *311 requested_reviewer: *4 required: - review_requester @@ -91257,7 +91748,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &679 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91288,8 +91779,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 dismissed_review: type: object properties: @@ -91317,7 +91808,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &678 + - &680 title: Locked Issue Event description: Locked Issue Event type: object @@ -91348,8 +91839,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 lock_reason: type: string example: '"off-topic"' @@ -91365,7 +91856,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &679 + - &681 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91396,8 +91887,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91431,7 +91922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &680 + - &682 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91462,8 +91953,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91497,7 +91988,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &681 + - &683 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91528,8 +92019,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91563,7 +92054,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &682 + - &684 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91654,7 +92145,7 @@ paths: color: red headers: Link: *43 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91671,9 +92162,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -91683,7 +92174,7 @@ paths: application/json: schema: type: array - items: &668 + items: &670 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91730,7 +92221,7 @@ paths: - color - default examples: - default: &669 + default: &671 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91748,9 +92239,9 @@ paths: default: false headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91767,9 +92258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -91828,12 +92319,12 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 - '301': *480 + default: *671 + '301': *481 '404': *6 - '410': *477 + '410': *660 '422': *15 x-github: githubCloudOnly: false @@ -91850,9 +92341,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -91912,12 +92403,12 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 - '301': *480 + default: *671 + '301': *481 '404': *6 - '410': *477 + '410': *660 '422': *15 x-github: githubCloudOnly: false @@ -91934,15 +92425,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '204': description: Response - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91961,9 +92452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: name in: path required: true @@ -91976,7 +92467,7 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: default: value: @@ -91987,9 +92478,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92009,9 +92500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -92039,7 +92530,7 @@ paths: '204': description: Response '403': *29 - '410': *477 + '410': *660 '404': *6 '422': *15 x-github: @@ -92057,9 +92548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '204': description: Response @@ -92089,20 +92580,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92119,9 +92610,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - 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. @@ -92147,13 +92638,13 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92171,9 +92662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92205,16 +92696,16 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -92236,10 +92727,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *466 - - *467 - - *665 - - *458 + - *469 + - *470 + - *667 + - *461 responses: '204': description: Response @@ -92268,9 +92759,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92292,9 +92783,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92327,9 +92818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -92339,13 +92830,13 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92373,9 +92864,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92402,16 +92893,16 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -92431,9 +92922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92464,9 +92955,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 '403': *29 '404': *6 '422': *7 @@ -92488,9 +92979,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -92505,8 +92996,6 @@ paths: description: Timeline Event type: object anyOf: - - *670 - - *671 - *672 - *673 - *674 @@ -92518,6 +93007,8 @@ paths: - *680 - *681 - *682 + - *683 + - *684 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92560,7 +93051,7 @@ paths: issue_url: type: string format: uri - author_association: *213 + author_association: *214 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -92570,9 +93061,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - event - actor @@ -92603,7 +93094,7 @@ paths: properties: type: type: string - issue: *226 + issue: *227 required: - event - created_at @@ -92803,7 +93294,7 @@ paths: type: string body_text: type: string - author_association: *213 + author_association: *214 required: - event - id @@ -92826,7 +93317,7 @@ paths: type: string comments: type: array - items: &704 + items: &706 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -92915,7 +93406,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *213 + author_association: *214 _links: type: object properties: @@ -92999,7 +93490,7 @@ paths: enum: - line - file - reactions: *214 + reactions: *215 body_html: type: string example: '"

comment body

"' @@ -93035,7 +93526,7 @@ paths: type: string comments: type: array - items: *584 + items: *585 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93066,8 +93557,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 required: - id @@ -93110,8 +93601,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 required: - id @@ -93154,8 +93645,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 state_reason: type: string nullable: true @@ -93324,7 +93815,7 @@ paths: headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93341,8 +93832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -93352,7 +93843,7 @@ paths: application/json: schema: type: array - items: &683 + items: &685 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93418,8 +93909,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -93455,9 +93946,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: - default: &684 + default: &686 value: id: 1 key: ssh-rsa AAA... @@ -93491,9 +93982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *466 - - *467 - - &685 + - *469 + - *470 + - &687 name: key_id description: The unique identifier of the key. in: path @@ -93505,9 +93996,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: - default: *684 + default: *686 '404': *6 x-github: githubCloudOnly: false @@ -93525,9 +94016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *466 - - *467 - - *685 + - *469 + - *470 + - *687 responses: '204': description: Response @@ -93547,8 +94038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -93558,9 +94049,9 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 + default: *671 headers: Link: *43 '404': *6 @@ -93581,8 +94072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -93618,9 +94109,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: - default: &686 + default: &688 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93652,8 +94143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93664,9 +94155,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: - default: *686 + default: *688 '404': *6 x-github: githubCloudOnly: false @@ -93683,8 +94174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93723,7 +94214,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: default: value: @@ -93749,8 +94240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93776,8 +94267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -93813,8 +94304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '202': *39 '403': @@ -93842,8 +94333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -93869,9 +94360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *466 - - *467 - - *560 + - *469 + - *470 + - *561 responses: '200': description: Response @@ -93933,8 +94424,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true required: - _links @@ -94016,8 +94507,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94082,8 +94573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94117,9 +94608,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *585 + schema: *586 examples: - default: *687 + default: *689 '204': description: Response when already merged '404': @@ -94144,8 +94635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *466 - - *467 + - *469 + - *470 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94186,12 +94677,12 @@ paths: application/json: schema: type: array - items: &688 + items: &690 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 examples: default: value: @@ -94247,8 +94738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94288,9 +94779,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: &689 + default: &691 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94349,9 +94840,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *466 - - *467 - - &690 + - *469 + - *470 + - &692 name: milestone_number description: The number that identifies the milestone. in: path @@ -94363,9 +94854,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: *689 + default: *691 '404': *6 x-github: githubCloudOnly: false @@ -94382,9 +94873,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 requestBody: required: false content: @@ -94422,9 +94913,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: *689 + default: *691 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94440,9 +94931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 responses: '204': description: Response @@ -94463,9 +94954,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: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 - *17 - *19 responses: @@ -94475,9 +94966,9 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 + default: *671 headers: Link: *43 x-github: @@ -94496,12 +94987,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: - - *466 - - *467 - - *691 - - *692 - - *216 + - *469 + - *470 - *693 + - *694 + - *217 + - *695 - *17 - *19 responses: @@ -94511,9 +95002,9 @@ paths: application/json: schema: type: array - items: *239 + items: *240 examples: - default: *694 + default: *696 headers: Link: *43 x-github: @@ -94537,8 +95028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -94596,14 +95087,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &695 + schema: &697 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94728,7 +95219,7 @@ paths: - custom_404 - public examples: - default: &696 + default: &698 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94769,8 +95260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94824,9 +95315,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '422': *15 '409': *114 x-github: @@ -94849,8 +95340,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94957,8 +95448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -94984,8 +95475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -94995,7 +95486,7 @@ paths: application/json: schema: type: array - items: &697 + items: &699 title: Page Build description: Page Build type: object @@ -95089,8 +95580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -95135,16 +95626,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: &698 + default: &700 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95192,8 +95683,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *466 - - *467 + - *469 + - *470 - name: build_id in: path required: true @@ -95204,9 +95695,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: *698 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95226,8 +95717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -95332,9 +95823,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: - - *466 - - *467 - - &699 + - *469 + - *470 + - &701 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95392,9 +95883,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *466 - - *467 - - *699 + - *469 + - *470 + - *701 responses: '204': *150 '404': *6 @@ -95421,8 +95912,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -95653,7 +96144,7 @@ paths: description: Empty response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -95680,8 +96171,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Private vulnerability reporting status @@ -95718,8 +96209,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: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '422': *14 @@ -95740,8 +96231,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: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '422': *14 @@ -95750,148 +96241,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: - - *466 - - *467 - - 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: *396 - 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: *43 - '401': *25 - '403': *29 - '404': *6 - '410': *477 - '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: - - *466 - - *467 - 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: *396 - examples: - default: *476 - '401': *25 - '403': *29 - '404': *6 - '410': *477 - '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 @@ -95905,8 +96254,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -95916,7 +96265,7 @@ paths: type: array items: *151 examples: - default: *700 + default: *702 '403': *29 '404': *6 x-github: @@ -95938,8 +96287,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -95955,7 +96304,7 @@ paths: required: - properties examples: - default: *701 + default: *703 responses: '204': description: No Content when custom property values are successfully created @@ -95993,8 +96342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96054,9 +96403,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: *702 + default: *704 headers: Link: *43 '304': *37 @@ -96088,8 +96437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -96154,7 +96503,7 @@ paths: description: Response content: application/json: - schema: &706 + schema: &708 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96265,8 +96614,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true active_lock_reason: type: string @@ -96311,7 +96660,7 @@ paths: nullable: true requested_teams: type: array - items: *433 + items: *436 nullable: true head: type: object @@ -96350,14 +96699,14 @@ paths: _links: type: object properties: - comments: *403 - commits: *403 - statuses: *403 - html: *403 - issue: *403 - review_comments: *403 - review_comment: *403 - self: *403 + comments: *406 + commits: *406 + statuses: *406 + html: *406 + issue: *406 + review_comments: *406 + review_comment: *406 + self: *406 required: - comments - commits @@ -96367,8 +96716,8 @@ paths: - review_comments - review_comment - self - author_association: *213 - auto_merge: *703 + author_association: *214 + auto_merge: *705 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96460,7 +96809,7 @@ paths: - merged_by - review_comments examples: - default: &707 + default: &709 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96987,8 +97336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - name: sort in: query required: false @@ -97007,7 +97356,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -97017,9 +97366,9 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: &709 + default: &711 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97096,17 +97445,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: &705 + default: &707 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97181,9 +97530,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -97205,9 +97554,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: *705 + default: *707 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97223,9 +97572,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -97246,9 +97595,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -97274,9 +97623,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -97297,9 +97646,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -97331,16 +97680,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -97362,10 +97711,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -97408,9 +97757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *466 - - *467 - - &708 + - *469 + - *470 + - &710 name: pull_number description: The number that identifies the pull request. in: path @@ -97423,9 +97772,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '304': *37 '404': *6 '406': @@ -97460,9 +97809,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -97504,9 +97853,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '422': *15 '403': *29 x-github: @@ -97528,9 +97877,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -97590,17 +97939,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -97630,10 +97979,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: - - *466 - - *467 - - *708 - - *236 + - *469 + - *470 + - *710 + - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -97643,7 +97992,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -97653,9 +98002,9 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: *709 + default: *711 headers: Link: *43 x-github: @@ -97688,9 +98037,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -97795,7 +98144,7 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: example-for-a-multi-line-comment: value: @@ -97883,10 +98232,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: - - *466 - - *467 - - *708 - - *225 + - *469 + - *470 + - *710 + - *226 requestBody: required: true content: @@ -97908,7 +98257,7 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: default: value: @@ -97994,9 +98343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -98006,9 +98355,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: *710 + default: *712 headers: Link: *43 x-github: @@ -98038,9 +98387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -98050,7 +98399,7 @@ paths: application/json: schema: type: array - items: *598 + items: *599 examples: default: value: @@ -98088,9 +98437,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 responses: '204': description: Response if pull request has been merged @@ -98113,9 +98462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -98226,9 +98575,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 responses: '200': description: Response @@ -98244,7 +98593,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 required: - users - teams @@ -98303,9 +98652,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -98342,7 +98691,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -98878,9 +99227,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -98914,7 +99263,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -99419,9 +99768,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -99431,7 +99780,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99500,7 +99849,7 @@ paths: type: string body_text: type: string - author_association: *213 + author_association: *214 required: - id - node_id @@ -99582,9 +99931,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -99670,9 +100019,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &713 + default: &715 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99735,10 +100084,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: - - *466 - - *467 - - *708 - - &712 + - *469 + - *470 + - *710 + - &714 name: review_id description: The unique identifier of the review. in: path @@ -99750,9 +100099,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &714 + default: &716 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99811,10 +100160,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -99837,7 +100186,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: default: value: @@ -99899,18 +100248,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 responses: '200': description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *713 + default: *715 '422': *7 '404': *6 x-github: @@ -99937,10 +100286,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 - *17 - *19 responses: @@ -100019,13 +100368,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *213 + author_association: *214 _links: type: object properties: - self: *403 - html: *403 - pull_request: *403 + self: *406 + html: *406 + pull_request: *406 required: - self - html @@ -100034,7 +100383,7 @@ paths: type: string body_html: type: string - reactions: *214 + reactions: *215 side: description: The side of the first line of the range for a multi-line comment. @@ -100175,10 +100524,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -100206,7 +100555,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: default: value: @@ -100269,10 +100618,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -100307,9 +100656,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *714 + default: *716 '404': *6 '422': *7 '403': *29 @@ -100331,9 +100680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -100396,8 +100745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *466 - - *467 + - *469 + - *470 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100410,9 +100759,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: &716 + default: &718 value: type: file encoding: base64 @@ -100454,8 +100803,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: - - *466 - - *467 + - *469 + - *470 - name: dir description: The alternate path to look for a README file in: path @@ -100475,9 +100824,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: *716 + default: *718 '404': *6 '422': *15 x-github: @@ -100499,8 +100848,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -100510,7 +100859,7 @@ paths: application/json: schema: type: array - items: &717 + items: &719 title: Release description: A release. type: object @@ -100581,7 +100930,7 @@ paths: author: *4 assets: type: array - items: &718 + items: &720 title: Release Asset description: Data related to a release. type: object @@ -100656,7 +101005,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *214 + reactions: *215 required: - assets_url - upload_url @@ -100768,8 +101117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -100845,9 +101194,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: &721 + default: &723 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100952,9 +101301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *466 - - *467 - - &719 + - *469 + - *470 + - &721 name: asset_id description: The unique identifier of the asset. in: path @@ -100966,9 +101315,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: - default: &720 + default: &722 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 @@ -101003,7 +101352,7 @@ paths: type: User site_admin: false '404': *6 - '302': *600 + '302': *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101019,9 +101368,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *466 - - *467 - - *719 + - *469 + - *470 + - *721 requestBody: required: false content: @@ -101049,9 +101398,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: - default: *720 + default: *722 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101067,9 +101416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *466 - - *467 - - *719 + - *469 + - *470 + - *721 responses: '204': description: Response @@ -101093,8 +101442,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -101179,16 +101528,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101205,8 +101554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *466 - - *467 + - *469 + - *470 - name: tag description: tag parameter in: path @@ -101219,9 +101568,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 '404': *6 x-github: githubCloudOnly: false @@ -101243,9 +101592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *466 - - *467 - - &722 + - *469 + - *470 + - &724 name: release_id description: The unique identifier of the release. in: path @@ -101259,9 +101608,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: *717 + schema: *719 examples: - default: *721 + default: *723 '401': description: Unauthorized x-github: @@ -101279,9 +101628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 requestBody: required: false content: @@ -101345,9 +101694,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 '404': description: Not Found if the discussion category name is invalid content: @@ -101368,9 +101717,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 responses: '204': description: Response @@ -101390,9 +101739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - *17 - *19 responses: @@ -101402,7 +101751,7 @@ paths: application/json: schema: type: array - items: *718 + items: *720 examples: default: value: @@ -101484,9 +101833,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: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - name: name in: query required: true @@ -101512,7 +101861,7 @@ paths: description: Response for successful upload content: application/json: - schema: *718 + schema: *720 examples: response-for-successful-upload: value: @@ -101567,9 +101916,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - 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. @@ -101593,9 +101942,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -101616,9 +101965,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 requestBody: required: true content: @@ -101648,16 +101997,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -101679,10 +102028,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *466 - - *467 - - *722 - - *458 + - *469 + - *470 + - *724 + - *461 responses: '204': description: Response @@ -101706,9 +102055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 - *17 - *19 responses: @@ -101725,7 +102074,7 @@ paths: oneOf: - allOf: - *165 - - &723 + - &725 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101746,67 +102095,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *723 + - *725 - allOf: - *167 - - *723 + - *725 - allOf: - *168 - - *723 + - *725 - allOf: - - *724 - - *723 + - *726 + - *725 - allOf: - *169 - - *723 + - *725 - allOf: - *170 - - *723 + - *725 - allOf: - *171 - - *723 + - *725 - allOf: - *172 - - *723 + - *725 - allOf: - *173 - - *723 + - *725 - allOf: - *174 - - *723 + - *725 - allOf: - *175 - - *723 + - *725 - allOf: - *176 - - *723 + - *725 - allOf: - *177 - - *723 + - *725 - allOf: - *178 - - *723 + - *725 - allOf: - *179 - - *723 + - *725 - allOf: - *180 - - *723 + - *725 - allOf: - *181 - - *723 + - *725 - allOf: - *182 - - *723 + - *725 - allOf: - *183 - - *723 + - *725 - allOf: - *184 - - *723 + - *725 - allOf: + - *727 - *725 - - *723 examples: default: value: @@ -101845,8 +102194,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - name: includes_parents @@ -101857,7 +102206,7 @@ paths: schema: type: boolean default: true - - *726 + - *728 responses: '200': description: Response @@ -101912,8 +102261,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 requestBody: description: Request body required: true @@ -101942,7 +102291,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *727 + items: *729 required: - name - enforcement @@ -101975,7 +102324,7 @@ paths: application/json: schema: *185 examples: - default: &736 + default: &738 value: id: 42 name: super cool ruleset @@ -102022,12 +102371,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *466 - - *467 - - *728 - - *101 - - *729 + - *469 + - *470 - *730 + - *101 + - *731 + - *732 - *17 - *19 responses: @@ -102035,9 +102384,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *733 examples: - default: *732 + default: *734 '404': *6 '500': *40 x-github: @@ -102058,17 +102407,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *466 - - *467 - - *733 + - *469 + - *470 + - *735 responses: '200': description: Response content: application/json: - schema: *734 + schema: *736 examples: - default: *735 + default: *737 '404': *6 '500': *40 x-github: @@ -102096,8 +102445,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102119,7 +102468,7 @@ paths: application/json: schema: *185 examples: - default: *736 + default: *738 '404': *6 '500': *40 put: @@ -102137,8 +102486,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102172,7 +102521,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *727 + items: *729 examples: default: value: @@ -102202,7 +102551,7 @@ paths: application/json: schema: *185 examples: - default: *736 + default: *738 '404': *6 '500': *40 delete: @@ -102220,8 +102569,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102244,8 +102593,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - name: ruleset_id @@ -102263,7 +102612,7 @@ paths: type: array items: *189 examples: - default: *418 + default: *421 '404': *6 '500': *40 x-github: @@ -102282,8 +102631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102301,7 +102650,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *422 examples: default: value: @@ -102356,21 +102705,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: - - *466 - - *467 - - *420 - - *421 - - *422 + - *469 + - *470 - *423 - - *106 - - *19 - - *17 - - *737 - - *738 - *424 - *425 - *426 + - *106 + - *19 + - *17 + - *739 + - *740 - *427 + - *428 + - *429 + - *430 responses: '200': description: Response @@ -102378,7 +102727,7 @@ paths: application/json: schema: type: array - items: &742 + items: &744 type: object properties: number: *123 @@ -102397,8 +102746,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *739 - resolution: *740 + state: *741 + resolution: *742 resolved_at: type: string format: date-time @@ -102494,7 +102843,7 @@ paths: pull request. ' - oneOf: *741 + oneOf: *743 nullable: true has_more_locations: type: boolean @@ -102643,16 +102992,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: - - *466 - - *467 - - *554 - - *427 + - *469 + - *470 + - *555 + - *430 responses: '200': description: Response content: application/json: - schema: *742 + schema: *744 examples: default: value: @@ -102704,9 +103053,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: true content: @@ -102714,15 +103063,16 @@ paths: schema: type: object properties: - state: *739 - resolution: *740 + state: *741 + resolution: *742 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -102733,7 +103083,7 @@ paths: description: Response content: application/json: - schema: *742 + schema: *744 examples: default: value: @@ -102808,9 +103158,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 - *19 - *17 responses: @@ -102821,7 +103171,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &924 + items: &926 type: object properties: type: @@ -102847,8 +103197,6 @@ paths: example: commit details: oneOf: - - *743 - - *744 - *745 - *746 - *747 @@ -102860,6 +103208,8 @@ paths: - *753 - *754 - *755 + - *756 + - *757 examples: default: value: @@ -102945,8 +103295,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -102954,14 +103304,14 @@ paths: schema: type: object properties: - reason: &757 + reason: &759 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *756 + placeholder_id: *758 required: - reason - placeholder_id @@ -102978,7 +103328,7 @@ paths: schema: type: object properties: - reason: *757 + reason: *759 expire_at: type: string format: date-time @@ -103024,8 +103374,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: - - *466 - - *467 + - *469 + - *470 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103040,7 +103390,7 @@ paths: properties: incremental_scans: type: array - items: &758 + items: &760 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103066,15 +103416,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *758 + items: *760 backfill_scans: type: array - items: *758 + items: *760 custom_pattern_backfill_scans: type: array items: allOf: - - *758 + - *760 - type: object properties: pattern_name: @@ -103144,8 +103494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *466 - - *467 + - *469 + - *470 - *106 - name: sort description: The property to sort the results by. @@ -103189,9 +103539,9 @@ paths: application/json: schema: type: array - items: *759 + items: *761 examples: - default: *760 + default: *762 '400': *14 '404': *6 x-github: @@ -103214,8 +103564,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -103288,7 +103638,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 required: - login - type @@ -103375,9 +103725,9 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: &762 + default: &764 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103610,8 +103960,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -103715,7 +104065,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: default: value: @@ -103862,17 +104212,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '200': description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: *762 + default: *764 '403': *29 '404': *6 x-github: @@ -103896,9 +104246,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 requestBody: required: true content: @@ -103971,7 +104321,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 required: - login - type @@ -104057,17 +104407,17 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: *762 - add_credit: *762 + default: *764 + add_credit: *764 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *255 + schema: *259 examples: invalid_state_transition: value: @@ -104098,9 +104448,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '202': *39 '400': *14 @@ -104127,17 +104477,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '202': description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 '400': *14 '422': *15 '403': *29 @@ -104163,8 +104513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -104263,8 +104613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104273,7 +104623,7 @@ paths: application/json: schema: type: array - items: &763 + items: &765 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104306,8 +104656,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -104383,8 +104733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -104480,8 +104830,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104635,8 +104985,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104646,7 +104996,7 @@ paths: application/json: schema: type: array - items: *763 + items: *765 examples: default: value: @@ -104679,8 +105029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *466 - - *467 + - *469 + - *470 - name: sha in: path required: true @@ -104734,7 +105084,7 @@ paths: description: Response content: application/json: - schema: *764 + schema: *766 examples: default: value: @@ -104788,8 +105138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -104801,7 +105151,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -104821,14 +105171,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &765 + schema: &767 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104896,8 +105246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -104923,7 +105273,7 @@ paths: description: Response content: application/json: - schema: *765 + schema: *767 examples: default: value: @@ -104950,8 +105300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -104971,8 +105321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -105051,8 +105401,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105060,7 +105410,7 @@ paths: application/json: schema: type: array - items: &766 + items: &768 title: Tag protection description: Tag protection type: object @@ -105112,8 +105462,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105136,7 +105486,7 @@ paths: description: Response content: application/json: - schema: *766 + schema: *768 examples: default: value: @@ -105167,8 +105517,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: - - *466 - - *467 + - *469 + - *470 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105205,8 +105555,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *466 - - *467 + - *469 + - *470 - name: ref in: path required: true @@ -105242,8 +105592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -105253,9 +105603,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 headers: Link: *43 '404': *6 @@ -105275,8 +105625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 responses: @@ -105284,7 +105634,7 @@ paths: description: Response content: application/json: - schema: &767 + schema: &769 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105296,7 +105646,7 @@ paths: required: - names examples: - default: &768 + default: &770 value: names: - octocat @@ -105319,8 +105669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105351,9 +105701,9 @@ paths: description: Response content: application/json: - schema: *767 + schema: *769 examples: - default: *768 + default: *770 '404': *6 '422': *7 x-github: @@ -105374,9 +105724,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *466 - - *467 - - &769 + - *469 + - *470 + - &771 name: per description: The time frame to display results for. in: query @@ -105405,7 +105755,7 @@ paths: example: 128 clones: type: array - items: &770 + items: &772 title: Traffic type: object properties: @@ -105492,8 +105842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105583,8 +105933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105644,9 +105994,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *466 - - *467 - - *769 + - *469 + - *470 + - *771 responses: '200': description: Response @@ -105665,7 +106015,7 @@ paths: example: 3782 views: type: array - items: *770 + items: *772 required: - uniques - count @@ -105742,8 +106092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105779,7 +106129,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -106017,8 +106367,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106041,8 +106391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -106064,8 +106414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -106091,8 +106441,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *466 - - *467 + - *469 + - *470 - name: ref in: path required: true @@ -106184,9 +106534,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106227,7 +106577,7 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: default: value: @@ -106337,7 +106687,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &778 + - &780 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106346,7 +106696,7 @@ paths: schema: type: string example: members - - &783 + - &785 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106357,7 +106707,7 @@ paths: default: 1 format: int32 example: 1 - - &784 + - &786 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106399,7 +106749,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &773 + items: &775 allOf: - type: object required: @@ -106474,7 +106824,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: &785 + meta: &787 type: object description: The metadata associated with the creation/updates to the user. @@ -106534,30 +106884,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &774 + '400': &776 description: Bad request content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '401': *772 - '403': &775 + schema: *773 + '401': *774 + '403': &777 description: Permission denied - '429': &776 + '429': &778 description: Too many requests content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '500': &777 + schema: *773 + '500': &779 description: Internal server error content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 + schema: *773 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106581,7 +106931,7 @@ paths: required: true content: application/json: - schema: &781 + schema: &783 type: object required: - schemas @@ -106641,9 +106991,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *773 + schema: *775 examples: - group: &779 + group: &781 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106662,13 +107012,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': *774 - '401': *772 - '403': *775 - '409': &782 + '400': *776 + '401': *774 + '403': *777 + '409': &784 description: Duplicate record detected - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106685,7 +107035,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: - - &780 + - &782 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106693,22 +107043,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *778 + - *780 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *773 + schema: *775 examples: - default: *779 - '400': *774 - '401': *772 - '403': *775 + default: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106727,13 +107077,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: - - *780 + - *782 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *783 examples: group: summary: Group @@ -106759,17 +107109,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *773 + schema: *775 examples: - group: *779 - groupWithMembers: *779 - '400': *774 - '401': *772 - '403': *775 + group: *781 + groupWithMembers: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106793,13 +107143,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: - - *780 + - *782 - *41 requestBody: required: true content: application/json: - schema: &792 + schema: &794 type: object required: - Operations @@ -106859,17 +107209,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *773 + schema: *775 examples: - updateGroup: *779 - addMembers: *779 - '400': *774 - '401': *772 - '403': *775 + updateGroup: *781 + addMembers: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106885,17 +107235,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: - - *780 + - *782 - *41 responses: '204': description: Group was deleted, no content - '400': *774 - '401': *772 - '403': *775 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106929,8 +107279,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *783 - - *784 + - *785 + - *786 - *41 responses: '200': @@ -106963,7 +107313,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &787 + items: &789 allOf: - type: object required: @@ -107042,7 +107392,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &786 + roles: &788 type: array description: The roles assigned to the user. items: @@ -107098,7 +107448,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *785 + meta: *787 startIndex: type: integer description: A starting index for the returned page @@ -107135,11 +107485,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *774 - '401': *772 - '403': *775 - '429': *776 - '500': *777 + '400': *776 + '401': *774 + '403': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107163,7 +107513,7 @@ paths: required: true content: application/json: - schema: &790 + schema: &792 type: object required: - schemas @@ -107245,9 +107595,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *786 + roles: *788 examples: - user: &791 + user: &793 summary: User value: schemas: @@ -107294,9 +107644,9 @@ paths: description: User has been created content: application/scim+json: - schema: *787 + schema: *789 examples: - user: &788 + user: &790 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107322,13 +107672,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: *788 - '400': *774 - '401': *772 - '403': *775 - '409': *782 - '429': *776 - '500': *777 + enterpriseOwner: *790 + '400': *776 + '401': *774 + '403': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107345,7 +107695,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: - - &789 + - &791 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107358,15 +107708,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *787 + schema: *789 examples: - default: *788 - '400': *774 - '401': *772 - '403': *775 + default: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107388,30 +107738,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: - - *789 + - *791 - *41 requestBody: required: true content: application/json: - schema: *790 + schema: *792 examples: - user: *791 + user: *793 responses: '200': description: User was updated content: application/scim+json: - schema: *787 + schema: *789 examples: - user: *788 - '400': *774 - '401': *772 - '403': *775 + user: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107446,13 +107796,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: - - *789 + - *791 - *41 requestBody: required: true content: application/json: - schema: *792 + schema: *794 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107492,18 +107842,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *787 + schema: *789 examples: - userMultiValuedProperties: *788 - userSingleValuedProperties: *788 - disableUser: *788 - '400': *774 - '401': *772 - '403': *775 + userMultiValuedProperties: *790 + userSingleValuedProperties: *790 + disableUser: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107523,17 +107873,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: - - *789 + - *791 - *41 responses: '204': description: User was deleted, no content - '400': *774 - '401': *772 - '403': *775 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107620,7 +107970,7 @@ paths: example: 1 Resources: type: array - items: &793 + items: &795 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107851,22 +108201,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &794 + '404': &796 description: Resource not found content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '403': &795 + schema: *773 + '403': &797 description: Forbidden content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '400': *774 - '429': *776 + schema: *773 + '400': *776 + '429': *778 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107892,9 +108242,9 @@ paths: description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: &796 + default: &798 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107917,17 +108267,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *794 - '403': *795 - '500': *777 + '404': *796 + '403': *797 + '500': *779 '409': description: Conflict content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '400': *774 + schema: *773 + '400': *776 requestBody: required: true content: @@ -108025,17 +108375,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 - '404': *794 - '403': *795 + default: *798 + '404': *796 + '403': *797 '304': *37 x-github: githubCloudOnly: true @@ -108059,18 +108409,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 + default: *798 '304': *37 - '404': *794 - '403': *795 + '404': *796 + '403': *797 requestBody: required: true content: @@ -108183,19 +108533,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 + default: *798 '304': *37 - '404': *794 - '403': *795 - '400': *774 + '404': *796 + '403': *797 + '400': *776 '429': description: Response content: @@ -108286,12 +108636,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *789 + - *791 responses: '204': description: Response - '404': *794 - '403': *795 + '404': *796 + '403': *797 '304': *37 x-github: githubCloudOnly: true @@ -108406,7 +108756,7 @@ paths: html_url: type: string format: uri - repository: *280 + repository: *284 score: type: number file_size: @@ -108424,7 +108774,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &797 + text_matches: &799 title: Search Result Text Matches type: array items: @@ -108587,7 +108937,7 @@ paths: enum: - author-date - committer-date - - &798 + - &800 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 @@ -108658,7 +109008,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true comment_count: type: integer @@ -108678,7 +109028,7 @@ paths: url: type: string format: uri - verification: *645 + verification: *646 required: - author - committer @@ -108697,7 +109047,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true parents: type: array @@ -108710,12 +109060,12 @@ paths: type: string sha: type: string - repository: *280 + repository: *284 score: type: number node_id: type: string - text_matches: *797 + text_matches: *799 required: - sha - node_id @@ -108908,7 +109258,7 @@ paths: - interactions - created - updated - - *798 + - *800 - *17 - *19 - name: advanced_search @@ -109005,11 +109355,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: type: string state_reason: @@ -109026,8 +109376,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true comments: type: integer @@ -109041,7 +109391,7 @@ paths: type: string format: date-time nullable: true - text_matches: *797 + text_matches: *799 pull_request: type: object properties: @@ -109074,7 +109424,7 @@ paths: type: string score: type: number - author_association: *213 + author_association: *214 draft: type: boolean repository: *74 @@ -109085,7 +109435,7 @@ paths: timeline_url: type: string format: uri - type: *364 + type: *368 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -109095,9 +109445,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - assignee - closed_at @@ -109266,7 +109616,7 @@ paths: enum: - created - updated - - *798 + - *800 - *17 - *19 responses: @@ -109310,7 +109660,7 @@ paths: nullable: true score: type: number - text_matches: *797 + text_matches: *799 required: - id - node_id @@ -109396,7 +109746,7 @@ paths: - forks - help-wanted-issues - updated - - *798 + - *800 - *17 - *19 responses: @@ -109615,8 +109965,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true permissions: type: object @@ -109635,7 +109985,7 @@ paths: - admin - pull - push - text_matches: *797 + text_matches: *799 temp_clone_token: type: string allow_merge_commit: @@ -109936,7 +110286,7 @@ paths: type: string format: uri nullable: true - text_matches: *797 + text_matches: *799 related: type: array nullable: true @@ -110129,7 +110479,7 @@ paths: - followers - repositories - joined - - *798 + - *800 - *17 - *19 responses: @@ -110233,7 +110583,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *797 + text_matches: *799 blog: type: string nullable: true @@ -110312,7 +110662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &802 + - &804 name: team_id description: The unique identifier of the team. in: path @@ -110324,9 +110674,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 x-github: githubCloudOnly: false @@ -110353,7 +110703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *802 + - *804 requestBody: required: true content: @@ -110416,16 +110766,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '201': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 '422': *15 '403': *29 @@ -110453,7 +110803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *802 + - *804 responses: '204': description: Response @@ -110484,7 +110834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *802 + - *804 - *106 - *17 - *19 @@ -110495,9 +110845,9 @@ paths: application/json: schema: type: array - items: *449 + items: *452 examples: - default: *803 + default: *805 headers: Link: *43 x-github: @@ -110526,7 +110876,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *802 + - *804 requestBody: required: true content: @@ -110560,9 +110910,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: triggersNotification: true githubCloudOnly: false @@ -110589,16 +110939,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 responses: '200': description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110623,8 +110973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 requestBody: required: false content: @@ -110647,9 +110997,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *804 + default: *806 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110674,8 +111024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 responses: '204': description: Response @@ -110704,8 +111054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *802 - - *451 + - *804 + - *454 - *106 - *17 - *19 @@ -110716,9 +111066,9 @@ paths: application/json: schema: type: array - items: *452 + items: *455 examples: - default: *805 + default: *807 headers: Link: *43 x-github: @@ -110747,8 +111097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 + - *454 requestBody: required: true content: @@ -110770,9 +111120,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: triggersNotification: true githubCloudOnly: false @@ -110799,17 +111149,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 responses: '200': description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110834,9 +111184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 requestBody: required: true content: @@ -110858,9 +111208,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *806 + default: *808 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110885,9 +111235,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 responses: '204': description: Response @@ -110916,9 +111266,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: - - *802 - - *451 + - *804 - *454 + - *457 - 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. @@ -110944,9 +111294,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -110975,9 +111325,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: - - *802 - - *451 + - *804 - *454 + - *457 requestBody: required: true content: @@ -111009,9 +111359,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111037,8 +111387,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: - - *802 - - *451 + - *804 + - *454 - 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. @@ -111064,9 +111414,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -111095,8 +111445,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: - - *802 - - *451 + - *804 + - *454 requestBody: required: true content: @@ -111128,9 +111478,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111154,7 +111504,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111164,9 +111514,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 x-github: @@ -111192,7 +111542,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *802 + - *804 - name: role description: Filters members returned by their role in the team. in: query @@ -111215,7 +111565,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -111243,7 +111593,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111280,7 +111630,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111320,7 +111670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111357,16 +111707,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: - - *802 + - *804 - *138 responses: '200': description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-user-is-a-team-maintainer: *807 + response-if-user-is-a-team-maintainer: *809 '404': *6 x-github: githubCloudOnly: false @@ -111399,7 +111749,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: - - *802 + - *804 - *138 requestBody: required: false @@ -111425,9 +111775,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-users-membership-with-team-is-now-pending: *808 + response-if-users-membership-with-team-is-now-pending: *810 '403': description: Forbidden if team synchronization is set up '422': @@ -111461,7 +111811,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: - - *802 + - *804 - *138 responses: '204': @@ -111490,7 +111840,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111500,9 +111850,9 @@ paths: application/json: schema: type: array - items: *464 + items: *467 examples: - default: *809 + default: *811 headers: Link: *43 '404': *6 @@ -111528,16 +111878,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: - - *802 - - *465 + - *804 + - *468 responses: '200': description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *810 + default: *812 '404': description: Not Found if project is not managed by this team x-github: @@ -111561,8 +111911,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: - - *802 - - *465 + - *804 + - *468 requestBody: required: false content: @@ -111629,8 +111979,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: - - *802 - - *465 + - *804 + - *468 responses: '204': description: Response @@ -111657,7 +112007,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111667,9 +112017,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '404': *6 @@ -111699,15 +112049,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *811 + schema: *813 examples: alternative-response-with-extra-repository-information: value: @@ -111858,9 +112208,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 requestBody: required: false content: @@ -111910,9 +112260,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 responses: '204': description: Response @@ -111941,15 +112291,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: - - *802 + - *804 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 '403': *29 '404': *6 x-github: @@ -111976,7 +112326,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: - - *802 + - *804 requestBody: required: true content: @@ -112033,7 +112383,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -112064,7 +112414,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -112074,9 +112424,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - response-if-child-teams-exist: *812 + response-if-child-teams-exist: *814 headers: Link: *43 '404': *6 @@ -112109,7 +112459,7 @@ paths: application/json: schema: oneOf: - - &814 + - &816 title: Private User description: Private User type: object @@ -112312,7 +112662,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *813 + - *815 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112465,7 +112815,7 @@ paths: description: Response content: application/json: - schema: *814 + schema: *816 examples: default: value: @@ -112544,7 +112894,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '304': *37 '404': *6 '403': *29 @@ -112668,9 +113018,9 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: - default: *370 + default: *374 '304': *37 '500': *40 '401': *25 @@ -112809,17 +113159,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -112863,7 +113213,7 @@ paths: type: integer secrets: type: array - items: &815 + items: &817 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112903,7 +113253,7 @@ paths: - visibility - selected_repositories_url examples: - default: *577 + default: *578 headers: Link: *43 x-github: @@ -112973,13 +113323,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: - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *815 + schema: *817 examples: default: value: @@ -113009,7 +113359,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: - - *290 + - *294 requestBody: required: true content: @@ -113054,7 +113404,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -113082,7 +113432,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: - - *290 + - *294 responses: '204': description: Response @@ -113107,7 +113457,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: - - *290 + - *294 responses: '200': description: Response @@ -113123,9 +113473,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *816 + default: *818 '401': *25 '403': *29 '404': *6 @@ -113150,7 +113500,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: - - *290 + - *294 requestBody: required: true content: @@ -113204,7 +113554,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: - - *290 + - *294 - name: repository_id in: path required: true @@ -113237,7 +113587,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: - - *290 + - *294 - name: repository_id in: path required: true @@ -113269,15 +113619,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '304': *37 '500': *40 '401': *25 @@ -113303,7 +113653,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: - - *371 + - *375 requestBody: required: false content: @@ -113333,9 +113683,9 @@ paths: description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -113357,7 +113707,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: - - *371 + - *375 responses: '202': *39 '304': *37 @@ -113386,13 +113736,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: - - *371 + - *375 responses: '202': description: Response content: application/json: - schema: &817 + schema: &819 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113433,7 +113783,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &818 + default: &820 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113465,7 +113815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *371 + - *375 - name: export_id in: path required: true @@ -113478,9 +113828,9 @@ paths: description: Response content: application/json: - schema: *817 + schema: *819 examples: - default: *818 + default: *820 '404': *6 x-github: githubCloudOnly: false @@ -113501,7 +113851,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *371 + - *375 responses: '200': description: Response @@ -113517,9 +113867,9 @@ paths: type: integer machines: type: array - items: *819 + items: *821 examples: - default: *820 + default: *822 '304': *37 '500': *40 '401': *25 @@ -113548,7 +113898,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: - - *371 + - *375 requestBody: required: true content: @@ -113598,13 +113948,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *479 + repository: *480 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *575 - required: *576 + properties: *576 + required: *577 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114378,15 +114728,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '304': *37 '500': *40 '400': *14 @@ -114418,15 +114768,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '500': *40 '401': *25 '403': *29 @@ -114456,9 +114806,9 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: &831 + default: &833 value: - id: 197 name: hello_docker @@ -114559,7 +114909,7 @@ paths: application/json: schema: type: array - items: &821 + items: &823 title: Email description: Email type: object @@ -114624,9 +114974,9 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: - default: &833 + default: &835 value: - email: octocat@github.com verified: true @@ -114701,7 +115051,7 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: default: value: @@ -114811,7 +115161,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '304': *37 @@ -114844,7 +115194,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '304': *37 @@ -114957,7 +115307,7 @@ paths: application/json: schema: type: array - items: &822 + items: &824 title: GPG Key description: A unique encryption key type: object @@ -115088,7 +115438,7 @@ paths: - subkeys - revoked examples: - default: &847 + default: &849 value: - id: 3 name: Octocat's GPG Key @@ -115173,9 +115523,9 @@ paths: description: Response content: application/json: - schema: *822 + schema: *824 examples: - default: &823 + default: &825 value: id: 3 name: Octocat's GPG Key @@ -115232,7 +115582,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: - - &824 + - &826 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115244,9 +115594,9 @@ paths: description: Response content: application/json: - schema: *822 + schema: *824 examples: - default: *823 + default: *825 '404': *6 '304': *37 '403': *29 @@ -115269,7 +115619,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: - - *824 + - *826 responses: '204': description: Response @@ -115460,7 +115810,7 @@ paths: type: array items: *74 examples: - default: *275 + default: *279 headers: Link: *43 '404': *6 @@ -115485,7 +115835,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *274 + - *278 responses: '204': description: Response @@ -115511,7 +115861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *274 + - *278 responses: '204': description: Response @@ -115545,12 +115895,12 @@ paths: application/json: schema: anyOf: - - *359 + - *363 - type: object properties: {} additionalProperties: false examples: - default: *360 + default: *364 '204': description: Response when there are no restrictions x-github: @@ -115574,7 +115924,7 @@ paths: required: true content: application/json: - schema: *656 + schema: *657 examples: default: value: @@ -115585,7 +115935,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -115666,7 +116016,7 @@ paths: - closed - all default: open - - *367 + - *371 - name: sort description: What to sort results by. in: query @@ -115679,7 +116029,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -115689,9 +116039,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *368 + default: *372 headers: Link: *43 '404': *6 @@ -115724,7 +116074,7 @@ paths: application/json: schema: type: array - items: &825 + items: &827 title: Key description: Key type: object @@ -115825,9 +116175,9 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: - default: &826 + default: &828 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115860,15 +116210,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: - - *685 + - *687 responses: '200': description: Response content: application/json: - schema: *825 + schema: *827 examples: - default: *826 + default: *828 '404': *6 '304': *37 '403': *29 @@ -115891,7 +116241,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: - - *685 + - *687 responses: '204': description: Response @@ -115924,7 +116274,7 @@ paths: application/json: schema: type: array - items: &827 + items: &829 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115981,7 +116331,7 @@ paths: - id - type - login - plan: *230 + plan: *231 required: - billing_cycle - next_billing_date @@ -115992,7 +116342,7 @@ paths: - account - plan examples: - default: &828 + default: &830 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116054,9 +116404,9 @@ paths: application/json: schema: type: array - items: *827 + items: *829 examples: - default: *828 + default: *830 headers: Link: *43 '304': *37 @@ -116096,7 +116446,7 @@ paths: application/json: schema: type: array - items: *372 + items: *376 examples: default: value: @@ -116204,7 +116554,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: default: value: @@ -116287,7 +116637,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: default: value: @@ -116355,7 +116705,7 @@ paths: application/json: schema: type: array - items: *374 + items: *378 examples: default: value: @@ -116608,7 +116958,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -116788,7 +117138,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *375 + - *379 - name: exclude in: query required: false @@ -116801,7 +117151,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -116995,7 +117345,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *375 + - *379 responses: '302': description: Response @@ -117021,7 +117371,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *375 + - *379 responses: '204': description: Response @@ -117050,8 +117400,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *375 - - *829 + - *379 + - *831 responses: '204': description: Response @@ -117075,7 +117425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *375 + - *379 - *17 - *19 responses: @@ -117085,9 +117435,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '404': *6 @@ -117124,7 +117474,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: *43 '304': *37 @@ -117166,7 +117516,7 @@ paths: - docker - nuget - container - - *830 + - *832 - *19 - *17 responses: @@ -117176,10 +117526,10 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 - '400': *832 + default: *833 + '400': *834 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117199,16 +117549,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: - - *382 - - *383 + - *386 + - *387 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: - default: &848 + default: &850 value: id: 40201 name: octo-name @@ -117321,8 +117671,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: - - *382 - - *383 + - *386 + - *387 responses: '204': description: Response @@ -117352,8 +117702,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: - - *382 - - *383 + - *386 + - *387 - name: token description: package token schema: @@ -117385,8 +117735,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: - - *382 - - *383 + - *386 + - *387 - *19 - *17 - name: state @@ -117406,7 +117756,7 @@ paths: application/json: schema: type: array - items: *384 + items: *388 examples: default: value: @@ -117455,15 +117805,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '200': description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -117499,9 +117849,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '204': description: Response @@ -117531,9 +117881,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '204': description: Response @@ -117545,97 +117895,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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: *396 - 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': *37 - '403': *29 - '401': *25 - '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 @@ -117661,9 +117920,9 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: - default: *833 + default: *835 headers: Link: *43 '304': *37 @@ -117776,7 +118035,7 @@ paths: type: array items: *74 examples: - default: &840 + default: &842 summary: Default response value: - id: 1296269 @@ -118080,9 +118339,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118120,9 +118379,9 @@ paths: application/json: schema: type: array - items: *658 + items: *659 examples: - default: *834 + default: *836 headers: Link: *43 '304': *37 @@ -118145,7 +118404,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *363 + - *367 responses: '204': description: Response @@ -118168,7 +118427,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *363 + - *367 responses: '204': description: Response @@ -118201,7 +118460,7 @@ paths: application/json: schema: type: array - items: &835 + items: &837 title: Social account description: Social media account type: object @@ -118216,7 +118475,7 @@ paths: - provider - url examples: - default: &836 + default: &838 value: - provider: twitter url: https://twitter.com/github @@ -118278,9 +118537,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 '422': *15 '304': *37 '404': *6 @@ -118367,7 +118626,7 @@ paths: application/json: schema: type: array - items: &837 + items: &839 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118387,7 +118646,7 @@ paths: - title - created_at examples: - default: &853 + default: &855 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118453,9 +118712,9 @@ paths: description: Response content: application/json: - schema: *837 + schema: *839 examples: - default: &838 + default: &840 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118486,7 +118745,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: - - &839 + - &841 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118498,9 +118757,9 @@ paths: description: Response content: application/json: - schema: *837 + schema: *839 examples: - default: *838 + default: *840 '404': *6 '304': *37 '403': *29 @@ -118523,7 +118782,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: - - *839 + - *841 responses: '204': description: Response @@ -118552,7 +118811,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: - - &854 + - &856 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 @@ -118577,11 +118836,11 @@ paths: type: array items: *74 examples: - default-response: *840 + default-response: *842 application/vnd.github.v3.star+json: schema: type: array - items: &855 + items: &857 title: Starred Repository description: Starred Repository type: object @@ -118737,8 +118996,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response if this repository is starred by you @@ -118766,8 +119025,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -118791,8 +119050,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -118825,9 +119084,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '304': *37 @@ -118864,7 +119123,7 @@ paths: application/json: schema: type: array - items: *447 + items: *450 examples: default: value: @@ -118942,7 +119201,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *232 + - *233 responses: '200': description: Response @@ -118950,10 +119209,10 @@ paths: application/json: schema: oneOf: - - *814 - - *813 + - *816 + - *815 examples: - default-response: &842 + default-response: &844 summary: Default response value: login: octocat @@ -118988,7 +119247,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &843 + response-with-git-hub-plan-information: &845 summary: Response with GitHub plan information value: login: octocat @@ -119048,7 +119307,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *841 + - *843 - *17 responses: '200': @@ -119059,7 +119318,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: example: ; rel="next" @@ -119097,11 +119356,11 @@ paths: application/json: schema: oneOf: - - *814 - - *813 + - *816 + - *815 examples: - default-response: *842 - response-with-git-hub-plan-information: *843 + default-response: *844 + response-with-git-hub-plan-information: *845 '404': *6 x-github: githubCloudOnly: false @@ -119151,8 +119410,8 @@ paths: required: - subject_digests examples: - default: *844 - withPredicateType: *845 + default: *846 + withPredicateType: *847 responses: '200': description: Response @@ -119205,7 +119464,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *846 + default: *848 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119410,12 +119669,12 @@ paths: initiator: type: string examples: - default: *519 + default: *520 '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -119449,9 +119708,9 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 + default: *833 '403': *29 '401': *25 x-github: @@ -119484,7 +119743,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119557,7 +119816,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119644,7 +119903,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119714,7 +119973,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -119745,7 +120004,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -119792,7 +120051,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - *138 - - *216 + - *217 - *17 - *19 responses: @@ -119802,9 +120061,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '422': *15 @@ -119835,9 +120094,9 @@ paths: application/json: schema: type: array - items: *822 + items: *824 examples: - default: *847 + default: *849 headers: Link: *43 x-github: @@ -119941,7 +120200,7 @@ paths: application/json: schema: *22 examples: - default: *655 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120026,7 +120285,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: *43 x-github: @@ -120065,7 +120324,7 @@ paths: - docker - nuget - container - - *830 + - *832 - *138 - *19 - *17 @@ -120076,12 +120335,12 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 + default: *833 '403': *29 '401': *25 - '400': *832 + '400': *834 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120101,17 +120360,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: - default: *848 + default: *850 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120132,8 +120391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 responses: '204': @@ -120166,8 +120425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - name: token description: package token @@ -120200,8 +120459,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: - - *382 - - *383 + - *386 + - *387 - *138 responses: '200': @@ -120210,7 +120469,7 @@ paths: application/json: schema: type: array - items: *384 + items: *388 examples: default: value: @@ -120268,16 +120527,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 - *138 responses: '200': description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -120312,10 +120571,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - - *385 + - *389 responses: '204': description: Response @@ -120347,10 +120606,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - - *385 + - *389 responses: '204': description: Response @@ -120362,87 +120621,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: - - *138 - - 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: *396 - 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: *43 - '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 @@ -120472,9 +120650,9 @@ paths: application/json: schema: type: array - items: *397 + items: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -120496,16 +120674,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *399 + - *402 - *138 responses: '200': description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -120527,7 +120705,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *399 + - *402 - *138 - *17 - *104 @@ -120539,9 +120717,9 @@ paths: application/json: schema: type: array - items: *400 + items: *403 examples: - default: *849 + default: *851 headers: Link: *43 '304': *37 @@ -120563,17 +120741,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *399 - - *850 + - *402 + - *852 - *138 responses: '200': description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: *851 + default: *853 headers: Link: *43 '304': *37 @@ -120596,7 +120774,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: - - *399 + - *402 - *138 - *104 - *105 @@ -120629,9 +120807,9 @@ paths: application/json: schema: type: array - items: *406 + items: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -120653,7 +120831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *138 - - *399 + - *402 requestBody: required: true description: Details of the item to add to the project. @@ -120690,10 +120868,10 @@ paths: description: Response content: application/json: - schema: *852 + schema: *854 examples: - issue: *405 - pull_request: *405 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -120713,9 +120891,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: - - *399 + - *402 - *138 - - *408 + - *411 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -120735,9 +120913,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -120758,9 +120936,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *399 + - *402 - *138 - - *408 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -120830,13 +121008,13 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - text_field: *407 - number_field: *407 - date_field: *407 - single_select_field: *407 - iteration_field: *407 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -120856,9 +121034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *399 + - *402 - *138 - - *408 + - *411 responses: '204': description: Response @@ -120895,7 +121073,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -120970,7 +121148,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -121076,9 +121254,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -121108,9 +121286,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121138,9 +121316,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *442 examples: - default: *440 + default: *443 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121161,11 +121339,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *138 - - *196 - - *198 - *197 - - *247 - - *200 + - *199 + - *198 + - *251 + - *201 responses: '200': description: Response when getting a billing premium request usage report @@ -121301,9 +121479,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121324,9 +121502,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *138 - - *196 - - *248 - *197 + - *252 + - *198 responses: '200': description: Response when getting a billing usage report @@ -121405,7 +121583,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. @@ -121418,18 +121596,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: - *138 - - *196 - - *198 - *197 - - *251 - - *200 - - *252 + - *199 + - *198 + - *255 + - *201 + - *256 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -121560,9 +121738,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 headers: Link: *43 x-github: @@ -121592,9 +121770,9 @@ paths: application/json: schema: type: array - items: *837 + items: *839 examples: - default: *853 + default: *855 headers: Link: *43 x-github: @@ -121619,7 +121797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *854 + - *856 - *106 - *17 - *19 @@ -121631,11 +121809,11 @@ paths: schema: anyOf: - type: array - items: *855 + items: *857 - type: array items: *74 examples: - default-response: *840 + default-response: *842 headers: Link: *43 x-github: @@ -121664,9 +121842,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -121794,7 +121972,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &856 + enterprise: &858 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121852,7 +122030,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &857 + installation: &859 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121871,7 +122049,7 @@ x-webhooks: required: - id - node_id - organization: &858 + organization: &860 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121931,13 +122109,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &859 + repository: &861 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &896 + properties: &898 id: description: Unique identifier of the repository example: 42 @@ -121957,8 +122135,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true organization: title: Simple User @@ -122620,7 +122798,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &897 + required: &899 - archive_url - assignees_url - blobs_url @@ -122771,10 +122949,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -122850,11 +123028,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: &860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: &862 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) @@ -123077,11 +123255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: *860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: *862 sender: *4 required: - action @@ -123264,11 +123442,11 @@ x-webhooks: - everyone required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: *860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: *862 sender: *4 required: - action @@ -123339,7 +123517,7 @@ x-webhooks: required: true content: application/json: - schema: &863 + schema: &865 title: Exemption request cancellation event type: object properties: @@ -123347,11 +123525,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: &861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: &863 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123584,7 +123762,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &862 + items: &864 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123692,7 +123870,7 @@ x-webhooks: required: true content: application/json: - schema: &864 + schema: &866 title: Exemption request completed event type: object properties: @@ -123700,11 +123878,11 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 sender: *4 required: - action @@ -123774,7 +123952,7 @@ x-webhooks: required: true content: application/json: - schema: &865 + schema: &867 title: Exemption request created event type: object properties: @@ -123782,11 +123960,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 sender: *4 required: - action @@ -123856,7 +124034,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &868 title: Exemption response dismissed event type: object properties: @@ -123864,12 +124042,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 - exemption_response: *862 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 + exemption_response: *864 sender: *4 required: - action @@ -123941,7 +124119,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &869 title: Exemption response submitted event type: object properties: @@ -123949,12 +124127,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 - exemption_response: *862 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 + exemption_response: *864 sender: *4 required: - action @@ -124027,7 +124205,7 @@ x-webhooks: required: true content: application/json: - schema: *863 + schema: *865 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124094,7 +124272,7 @@ x-webhooks: required: true content: application/json: - schema: *864 + schema: *866 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124161,7 +124339,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124228,7 +124406,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124296,7 +124474,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124374,7 +124552,7 @@ x-webhooks: type: string enum: - completed - check_run: &869 + check_run: &871 title: CheckRun description: A check performed on the code of a given code change type: object @@ -124427,8 +124605,8 @@ x-webhooks: type: string pull_requests: type: array - items: *536 - repository: *280 + items: *537 + repository: *284 status: example: completed type: string @@ -124465,7 +124643,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *868 + deployment: *870 details_url: example: https://example.com type: string @@ -124515,7 +124693,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *536 + items: *537 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -124550,10 +124728,10 @@ x-webhooks: - output - app - pull_requests - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -124946,11 +125124,11 @@ x-webhooks: type: string enum: - created - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -125346,11 +125524,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 requested_action: description: The action requested by the user. type: object @@ -125755,11 +125933,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -126736,10 +126914,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -127409,10 +127587,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -128076,10 +128254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -128245,7 +128423,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128390,20 +128568,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &870 + commit_oid: &872 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: *856 - installation: *857 - organization: *858 - ref: &871 + enterprise: *858 + installation: *859 + organization: *860 + ref: &873 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: *859 + repository: *861 sender: *4 required: - action @@ -128568,7 +128746,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128798,12 +128976,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -128898,7 +129076,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129069,12 +129247,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -129240,7 +129418,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129406,12 +129584,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -129511,7 +129689,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129679,16 +129857,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *859 + repository: *861 sender: *4 required: - action @@ -129785,7 +129963,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129925,12 +130103,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -130187,10 +130365,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -130270,18 +130448,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *858 - pusher_type: &872 + organization: *860 + pusher_type: &874 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &873 + ref: &875 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -130291,7 +130469,7 @@ x-webhooks: enum: - tag - branch - repository: *859 + repository: *861 sender: *4 required: - ref @@ -130374,9 +130552,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130461,9 +130639,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130541,9 +130719,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130621,9 +130799,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130700,10 +130878,10 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - repository: *859 - organization: *858 + enterprise: *858 + installation: *859 + repository: *861 + organization: *860 sender: *4 new_property_values: type: array @@ -130788,18 +130966,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - pusher_type: *872 - ref: *873 + enterprise: *858 + installation: *859 + organization: *860 + pusher_type: *874 + ref: *875 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *859 + repository: *861 sender: *4 required: - ref @@ -130883,11 +131061,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -130971,11 +131149,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131059,11 +131237,11 @@ x-webhooks: type: string enum: - created - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131145,11 +131323,11 @@ x-webhooks: type: string enum: - dismissed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131231,11 +131409,11 @@ x-webhooks: type: string enum: - fixed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131318,11 +131496,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131404,11 +131582,11 @@ x-webhooks: type: string enum: - reopened - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131485,9 +131663,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - key: &874 + enterprise: *858 + installation: *859 + key: &876 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131523,8 +131701,8 @@ x-webhooks: - verified - created_at - read_only - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -131601,11 +131779,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - key: *874 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + key: *876 + organization: *860 + repository: *861 sender: *4 required: - action @@ -132166,12 +132344,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: &878 + workflow: &880 title: Workflow type: object nullable: true @@ -132897,13 +133075,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *611 + deployment: *612 pull_requests: type: array - items: *706 - repository: *859 - organization: *858 - installation: *857 + items: *708 + repository: *861 + organization: *860 + installation: *859 sender: *4 responses: '200': @@ -132974,7 +133152,7 @@ x-webhooks: type: string enum: - approved - approver: &875 + approver: &877 type: object properties: avatar_url: @@ -133017,11 +133195,11 @@ x-webhooks: type: string comment: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - reviewers: &876 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + reviewers: &878 type: array items: type: object @@ -133100,7 +133278,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &877 + workflow_job_run: &879 type: object properties: conclusion: @@ -133831,18 +134009,18 @@ x-webhooks: type: string enum: - rejected - approver: *875 + approver: *877 comment: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - reviewers: *876 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + reviewers: *878 sender: *4 since: type: string - workflow_job_run: *877 + workflow_job_run: *879 workflow_job_runs: type: array items: @@ -134546,13 +134724,13 @@ x-webhooks: type: string enum: - requested - enterprise: *856 + enterprise: *858 environment: type: string - installation: *857 - organization: *858 - repository: *859 - requestor: &883 + installation: *859 + organization: *860 + repository: *861 + requestor: &885 title: User type: object nullable: true @@ -136451,12 +136629,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Deployment Workflow Run type: object @@ -137136,7 +137314,7 @@ x-webhooks: type: string enum: - answered - answer: &881 + answer: &883 type: object properties: author_association: @@ -137293,7 +137471,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &879 + discussion: &881 title: Discussion description: A Discussion in a repository. type: object @@ -137579,7 +137757,7 @@ x-webhooks: - id labels: type: array - items: *668 + items: *670 required: - repository_url - category @@ -137601,10 +137779,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137731,11 +137909,11 @@ x-webhooks: - from required: - category - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137818,11 +137996,11 @@ x-webhooks: type: string enum: - closed - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137904,7 +138082,7 @@ x-webhooks: type: string enum: - created - comment: &880 + comment: &882 type: object properties: author_association: @@ -138061,11 +138239,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138148,12 +138326,12 @@ x-webhooks: type: string enum: - deleted - comment: *880 - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + comment: *882 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138248,12 +138426,12 @@ x-webhooks: - from required: - body - comment: *880 - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + comment: *882 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138337,11 +138515,11 @@ x-webhooks: type: string enum: - created - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138423,11 +138601,11 @@ x-webhooks: type: string enum: - deleted - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138527,11 +138705,11 @@ x-webhooks: type: string required: - from - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138613,10 +138791,10 @@ x-webhooks: type: string enum: - labeled - discussion: *879 - enterprise: *856 - installation: *857 - label: &882 + discussion: *881 + enterprise: *858 + installation: *859 + label: &884 title: Label type: object properties: @@ -138648,8 +138826,8 @@ x-webhooks: - color - default - description - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138732,11 +138910,11 @@ x-webhooks: type: string enum: - locked - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138818,11 +138996,11 @@ x-webhooks: type: string enum: - pinned - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138904,11 +139082,11 @@ x-webhooks: type: string enum: - reopened - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138993,16 +139171,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *879 - new_repository: *859 + new_discussion: *881 + new_repository: *861 required: - new_discussion - new_repository - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139085,10 +139263,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *879 - old_answer: *881 - organization: *858 - repository: *859 + discussion: *881 + old_answer: *883 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139170,12 +139348,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *879 - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139258,11 +139436,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139344,11 +139522,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139417,7 +139595,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139480,7 +139658,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139546,7 +139724,7 @@ x-webhooks: required: true content: application/json: - schema: *863 + schema: *865 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139612,7 +139790,7 @@ x-webhooks: required: true content: application/json: - schema: *864 + schema: *866 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139678,7 +139856,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139744,7 +139922,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139810,7 +139988,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139877,7 +140055,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *856 + enterprise: *858 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -140537,9 +140715,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - forkee @@ -140685,9 +140863,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pages: description: The pages that were updated. type: array @@ -140724,7 +140902,7 @@ x-webhooks: - action - sha - html_url - repository: *859 + repository: *861 sender: *4 required: - pages @@ -140800,10 +140978,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: &884 + organization: *860 + repositories: &886 description: An array of repository objects that the installation can access. type: array @@ -140829,8 +141007,8 @@ x-webhooks: - name - full_name - private - repository: *859 - requester: *883 + repository: *861 + requester: *885 sender: *4 required: - action @@ -140905,11 +141083,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -140985,11 +141163,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141065,10 +141243,10 @@ x-webhooks: type: string enum: - added - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories_added: &885 + organization: *860 + repositories_added: &887 description: An array of repository objects, which were added to the installation. type: array @@ -141114,15 +141292,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *859 - repository_selection: &886 + repository: *861 + repository_selection: &888 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *883 + requester: *885 sender: *4 required: - action @@ -141201,10 +141379,10 @@ x-webhooks: type: string enum: - removed - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories_added: *885 + organization: *860 + repositories_added: *887 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -141231,9 +141409,9 @@ x-webhooks: - name - full_name - private - repository: *859 - repository_selection: *886 - requester: *883 + repository: *861 + repository_selection: *888 + requester: *885 sender: *4 required: - action @@ -141312,11 +141490,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141495,10 +141673,10 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 target_type: type: string @@ -141577,11 +141755,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141705,8 +141883,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 reactions: title: Reactions type: object @@ -141833,8 +142011,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142628,8 +142806,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142645,7 +142823,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -142978,8 +143156,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -143059,7 +143237,7 @@ x-webhooks: type: string enum: - deleted - comment: &887 + comment: &889 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -143224,8 +143402,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144015,8 +144193,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144032,7 +144210,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -144367,8 +144545,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -144448,7 +144626,7 @@ x-webhooks: type: string enum: - edited - changes: &916 + changes: &918 description: The changes to the comment. type: object properties: @@ -144460,9 +144638,9 @@ x-webhooks: type: string required: - from - comment: *887 - enterprise: *856 - installation: *857 + comment: *889 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145255,8 +145433,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145272,7 +145450,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -145605,8 +145783,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145690,15 +145868,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 + blocking_issue: *227 blocking_issue_repo: *74 - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145786,15 +145964,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 + blocking_issue: *227 blocking_issue_repo: *74 - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145881,15 +146059,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 - installation: *857 - organization: *858 - repository: *859 + blocking_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145977,15 +146155,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 - installation: *857 - organization: *858 - repository: *859 + blocking_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -146070,10 +146248,10 @@ x-webhooks: type: string enum: - assigned - assignee: *883 - enterprise: *856 - installation: *857 - issue: &890 + assignee: *885 + enterprise: *858 + installation: *859 + issue: &892 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146862,11 +147040,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146882,7 +147060,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -146983,8 +147161,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -147064,8 +147242,8 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147859,11 +148037,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147879,7 +148057,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -148115,8 +148293,8 @@ x-webhooks: required: - state - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -148195,8 +148373,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148981,11 +149159,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149001,7 +149179,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -149101,8 +149279,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -149181,8 +149359,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149989,11 +150167,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150009,7 +150187,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -150088,7 +150266,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &888 + milestone: &890 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150226,8 +150404,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -150326,8 +150504,8 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151116,11 +151294,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151133,7 +151311,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -151237,9 +151415,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *882 - organization: *858 - repository: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -151319,8 +151497,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152108,11 +152286,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152125,7 +152303,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -152229,9 +152407,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *882 - organization: *858 - repository: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -152311,8 +152489,8 @@ x-webhooks: type: string enum: - locked - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153124,11 +153302,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153141,7 +153319,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -153222,8 +153400,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -153302,8 +153480,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154109,11 +154287,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154129,7 +154307,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -154207,9 +154385,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *888 - organization: *858 - repository: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -155077,11 +155255,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155174,7 +155352,7 @@ x-webhooks: required: - login - id - type: *364 + type: *368 required: - id - number @@ -155643,8 +155821,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156433,11 +156611,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156453,7 +156631,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -156553,8 +156731,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -156634,9 +156812,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *856 - installation: *857 - issue: &889 + enterprise: *858 + installation: *859 + issue: &891 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -157419,11 +157597,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157439,7 +157617,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -157539,8 +157717,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -157619,8 +157797,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -158430,11 +158608,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158528,9 +158706,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *364 - organization: *858 - repository: *859 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -159396,11 +159574,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159416,7 +159594,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -159984,11 +160162,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *856 - installation: *857 - issue: *889 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *891 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160068,12 +160246,12 @@ x-webhooks: type: string enum: - typed - enterprise: *856 - installation: *857 - issue: *890 - type: *364 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160154,7 +160332,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &919 + assignee: &921 title: User type: object nullable: true @@ -160224,11 +160402,11 @@ x-webhooks: required: - login - id - enterprise: *856 - installation: *857 - issue: *890 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160307,12 +160485,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *856 - installation: *857 - issue: *890 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160392,8 +160570,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161203,11 +161381,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161223,7 +161401,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -161301,8 +161479,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161382,11 +161560,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *856 - installation: *857 - issue: *889 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *891 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161465,12 +161643,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *856 - installation: *857 - issue: *890 - type: *364 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161550,11 +161728,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161632,11 +161810,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161746,11 +161924,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161832,9 +162010,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: &891 + enterprise: *858 + installation: *859 + marketplace_purchase: &893 title: Marketplace Purchase type: object required: @@ -161917,8 +162095,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *858 - previous_marketplace_purchase: &892 + organization: *860 + previous_marketplace_purchase: &894 title: Marketplace Purchase type: object properties: @@ -161998,7 +162176,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162078,10 +162256,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162164,7 +162342,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162246,10 +162424,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162331,7 +162509,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162412,8 +162590,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 marketplace_purchase: title: Marketplace Purchase type: object @@ -162495,9 +162673,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *858 - previous_marketplace_purchase: *892 - repository: *859 + organization: *860 + previous_marketplace_purchase: *894 + repository: *861 sender: *4 required: - action @@ -162577,12 +162755,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 - previous_marketplace_purchase: *892 - repository: *859 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 + previous_marketplace_purchase: *894 + repository: *861 sender: *4 required: - action @@ -162684,11 +162862,11 @@ x-webhooks: type: string required: - to - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162788,11 +162966,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162871,11 +163049,11 @@ x-webhooks: type: string enum: - removed - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162953,11 +163131,11 @@ x-webhooks: type: string enum: - added - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163033,7 +163211,7 @@ x-webhooks: required: - login - id - team: &893 + team: &895 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -163256,11 +163434,11 @@ x-webhooks: type: string enum: - removed - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163337,7 +163515,7 @@ x-webhooks: required: - login - id - team: *893 + team: *895 required: - action - scope @@ -163419,8 +163597,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *857 - merge_group: &895 + installation: *859 + merge_group: &897 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -163439,15 +163617,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *894 + head_commit: *896 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163533,10 +163711,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *857 - merge_group: *895 - organization: *858 - repository: *859 + installation: *859 + merge_group: *897 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163609,7 +163787,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 + enterprise: *858 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163718,16 +163896,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *857 - organization: *858 + installation: *859 + organization: *860 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -163808,11 +163986,11 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163891,9 +164069,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - milestone: &898 + enterprise: *858 + installation: *859 + milestone: &900 title: Milestone description: A collection of related issues and pull requests. type: object @@ -164030,8 +164208,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164110,11 +164288,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164224,11 +164402,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164308,11 +164486,11 @@ x-webhooks: type: string enum: - opened - enterprise: *856 - installation: *857 - milestone: *898 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *900 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164391,11 +164569,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *883 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + blocked_user: *885 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164474,11 +164652,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *883 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + blocked_user: *885 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164554,7 +164732,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *856 + enterprise: *858 sender: *4 required: - action @@ -164634,8 +164812,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 sender: *4 required: - action @@ -164708,8 +164886,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 sender: *4 required: - action @@ -164781,9 +164959,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 new_property_values: type: array @@ -164871,9 +165049,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - membership: &899 + enterprise: *858 + installation: *859 + membership: &901 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164980,8 +165158,8 @@ x-webhooks: - role - organization_url - user - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165059,11 +165237,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165142,8 +165320,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -165259,10 +165437,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 - user: *883 + user: *885 required: - action - invitation @@ -165340,11 +165518,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165431,11 +165609,11 @@ x-webhooks: properties: from: type: string - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165511,9 +165689,9 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 package: description: Information about the package. type: object @@ -166012,7 +166190,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &900 + items: &902 title: Ruby Gems metadata type: object properties: @@ -166107,7 +166285,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -166183,9 +166361,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 package: description: Information about the package. type: object @@ -166538,7 +166716,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *900 + items: *902 source_url: type: string format: uri @@ -166608,7 +166786,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -166785,12 +166963,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *856 + enterprise: *858 id: type: integer - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - id @@ -166867,7 +167045,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &901 + personal_access_token_request: &903 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -167013,10 +167191,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *856 - organization: *858 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167093,11 +167271,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *901 - enterprise: *856 - organization: *858 + personal_access_token_request: *903 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167173,11 +167351,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *901 - enterprise: *856 - organization: *858 + personal_access_token_request: *903 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167252,11 +167430,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *901 - organization: *858 - enterprise: *856 + personal_access_token_request: *903 + organization: *860 + enterprise: *858 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167361,7 +167539,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *902 + last_response: *904 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -167393,8 +167571,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 zen: description: Random string of GitHub zen. @@ -167639,10 +167817,10 @@ x-webhooks: - from required: - note - enterprise: *856 - installation: *857 - organization: *858 - project_card: &903 + enterprise: *858 + installation: *859 + organization: *860 + project_card: &905 title: Project Card type: object properties: @@ -167761,7 +167939,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -167842,11 +168020,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project_card: *903 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_card: *905 + repository: *861 sender: *4 required: - action @@ -167926,9 +168104,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 project_card: title: Project Card type: object @@ -168056,8 +168234,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -168151,11 +168329,11 @@ x-webhooks: - from required: - note - enterprise: *856 - installation: *857 - organization: *858 - project_card: *903 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_card: *905 + repository: *861 sender: *4 required: - action @@ -168249,9 +168427,9 @@ x-webhooks: - from required: - column_id - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 project_card: allOf: - title: Project Card @@ -168441,7 +168619,7 @@ x-webhooks: type: string required: - after_id - repository: *859 + repository: *861 sender: *4 required: - action @@ -168521,10 +168699,10 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - organization: *858 - project: &905 + enterprise: *858 + installation: *859 + organization: *860 + project: &907 title: Project type: object properties: @@ -168648,7 +168826,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -168728,10 +168906,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project_column: &904 + enterprise: *858 + installation: *859 + organization: *860 + project_column: &906 title: Project Column type: object properties: @@ -168770,7 +168948,7 @@ x-webhooks: - name - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -168849,18 +169027,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -168950,11 +169128,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 + repository: *861 sender: *4 required: - action @@ -169034,11 +169212,11 @@ x-webhooks: type: string enum: - moved - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 + repository: *861 sender: *4 required: - action @@ -169118,11 +169296,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169202,18 +169380,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - project: *905 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -169315,11 +169493,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169398,11 +169576,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169483,9 +169661,9 @@ x-webhooks: type: string enum: - closed - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169566,9 +169744,9 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169649,9 +169827,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169768,9 +169946,9 @@ x-webhooks: type: string to: type: string - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169853,7 +170031,7 @@ x-webhooks: type: string enum: - archived - changes: &909 + changes: &911 type: object properties: archived_at: @@ -169867,9 +170045,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *857 - organization: *858 - projects_v2_item: &906 + installation: *859 + organization: *860 + projects_v2_item: &908 title: Projects v2 Item description: An item belonging to a project type: object @@ -169887,7 +170065,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *404 + content_type: *407 creator: *4 created_at: type: string @@ -170004,9 +170182,9 @@ x-webhooks: nullable: true to: type: string - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170088,9 +170266,9 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170171,9 +170349,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170279,7 +170457,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &907 + - &909 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -170301,7 +170479,7 @@ x-webhooks: required: - id - name - - &908 + - &910 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -170335,8 +170513,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *907 - - *908 + - *909 + - *910 required: - field_value - type: object @@ -170352,9 +170530,9 @@ x-webhooks: nullable: true required: - body - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170449,9 +170627,9 @@ x-webhooks: to: type: string nullable: true - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170534,10 +170712,10 @@ x-webhooks: type: string enum: - restored - changes: *909 - installation: *857 - organization: *858 - projects_v2_item: *906 + changes: *911 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170619,9 +170797,9 @@ x-webhooks: type: string enum: - reopened - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -170702,14 +170880,14 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2_status_update: &912 + installation: *859 + organization: *860 + projects_v2_status_update: &914 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *910 - required: *911 + properties: *912 + required: *913 sender: *4 required: - action @@ -170790,9 +170968,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2_status_update: *912 + installation: *859 + organization: *860 + projects_v2_status_update: *914 sender: *4 required: - action @@ -170928,9 +171106,9 @@ x-webhooks: type: string format: date nullable: true - installation: *857 - organization: *858 - projects_v2_status_update: *912 + installation: *859 + organization: *860 + projects_v2_status_update: *914 sender: *4 required: - action @@ -171001,10 +171179,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - repository @@ -171081,13 +171259,13 @@ x-webhooks: type: string enum: - assigned - assignee: *883 - enterprise: *856 - installation: *857 - number: &913 + assignee: *885 + enterprise: *858 + installation: *859 + number: &915 description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -173370,7 +173548,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -173452,11 +173630,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -175734,7 +175912,7 @@ x-webhooks: - draft reason: type: string - repository: *859 + repository: *861 sender: *4 required: - action @@ -175816,11 +175994,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -178098,7 +178276,7 @@ x-webhooks: - draft reason: type: string - repository: *859 + repository: *861 sender: *4 required: - action @@ -178180,13 +178358,13 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: &914 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: &916 allOf: - - *706 + - *708 - type: object properties: allow_auto_merge: @@ -178248,7 +178426,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *859 + repository: *861 sender: *4 required: - action @@ -178329,12 +178507,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -178414,11 +178592,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *856 - milestone: *688 - number: *913 - organization: *858 - pull_request: &915 + enterprise: *858 + milestone: *690 + number: *915 + organization: *860 + pull_request: &917 title: Pull Request type: object properties: @@ -180681,7 +180859,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -180760,11 +180938,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -183046,7 +183224,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *859 + repository: *861 sender: *4 required: - action @@ -183170,12 +183348,12 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -183255,11 +183433,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -185526,7 +185704,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -185606,11 +185784,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *856 - installation: *857 - label: *882 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + label: *884 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -187892,7 +188070,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -187973,10 +188151,10 @@ x-webhooks: type: string enum: - locked - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -190256,7 +190434,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -190336,12 +190514,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *856 - milestone: *688 - number: *913 - organization: *858 - pull_request: *915 - repository: *859 + enterprise: *858 + milestone: *690 + number: *915 + organization: *860 + pull_request: *917 + repository: *861 sender: *4 required: - action @@ -190420,12 +190598,12 @@ x-webhooks: type: string enum: - opened - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190506,12 +190684,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190591,12 +190769,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190962,9 +191140,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -193134,7 +193312,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -193214,7 +193392,7 @@ x-webhooks: type: string enum: - deleted - comment: &917 + comment: &919 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. @@ -193499,9 +193677,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -195659,7 +195837,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -195739,11 +195917,11 @@ x-webhooks: type: string enum: - edited - changes: *916 - comment: *917 - enterprise: *856 - installation: *857 - organization: *858 + changes: *918 + comment: *919 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -197904,7 +198082,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -197985,9 +198163,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -200160,7 +200338,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 review: description: The review that was affected. type: object @@ -200407,9 +200585,9 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -202463,8 +202641,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 - review: &918 + repository: *861 + review: &920 description: The review that was affected. type: object properties: @@ -202697,12 +202875,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -204985,7 +205163,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_reviewer: title: User type: object @@ -205069,12 +205247,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -207364,7 +207542,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207556,12 +207734,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -209846,7 +210024,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_reviewer: title: User type: object @@ -209931,12 +210109,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -212212,7 +212390,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212393,9 +212571,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -214570,8 +214748,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 - review: *918 + repository: *861 + review: *920 sender: *4 required: - action @@ -214651,9 +214829,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -216723,7 +216901,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 sender: *4 thread: type: object @@ -217110,9 +217288,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -219168,7 +219346,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 sender: *4 thread: type: object @@ -219558,10 +219736,10 @@ x-webhooks: type: string before: type: string - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -221832,7 +222010,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -221914,11 +222092,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *919 - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + assignee: *921 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -224201,7 +224379,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -224280,11 +224458,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *856 - installation: *857 - label: *882 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + label: *884 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -226557,7 +226735,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -226638,10 +226816,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -228906,7 +229084,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -229106,7 +229284,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *856 + enterprise: *858 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -229198,8 +229376,8 @@ x-webhooks: - url - author - committer - installation: *857 - organization: *858 + installation: *859 + organization: *860 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229774,9 +229952,9 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 registry_package: type: object properties: @@ -230222,7 +230400,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *900 + items: *902 summary: type: string tag_name: @@ -230276,7 +230454,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -230354,9 +230532,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 registry_package: type: object properties: @@ -230664,7 +230842,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *900 + items: *902 summary: type: string tag_name: @@ -230713,7 +230891,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -230790,10 +230968,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - release: &920 + enterprise: *858 + installation: *859 + organization: *860 + release: &922 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231111,7 +231289,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *859 + repository: *861 sender: *4 required: - action @@ -231188,11 +231366,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -231309,11 +231487,11 @@ x-webhooks: type: boolean required: - to - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -231391,9 +231569,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231715,7 +231893,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *859 + repository: *861 sender: *4 required: - action @@ -231791,10 +231969,10 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - release: &921 + enterprise: *858 + installation: *859 + organization: *860 + release: &923 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -232113,7 +232291,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *859 + repository: *861 sender: *4 required: - action @@ -232189,11 +232367,11 @@ x-webhooks: type: string enum: - released - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -232269,11 +232447,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *856 - installation: *857 - organization: *858 - release: *921 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *923 + repository: *861 sender: *4 required: - action @@ -232349,11 +232527,11 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - repository_advisory: *759 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + repository_advisory: *761 sender: *4 required: - action @@ -232429,11 +232607,11 @@ x-webhooks: type: string enum: - reported - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - repository_advisory: *759 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + repository_advisory: *761 sender: *4 required: - action @@ -232509,10 +232687,10 @@ x-webhooks: type: string enum: - archived - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232589,10 +232767,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232670,10 +232848,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232757,10 +232935,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232872,10 +233050,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232947,10 +233125,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 status: type: string @@ -233031,10 +233209,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233111,10 +233289,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233208,10 +233386,10 @@ x-webhooks: - name required: - repository - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233291,10 +233469,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 sender: *4 required: @@ -233373,10 +233551,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 sender: *4 required: @@ -233455,10 +233633,10 @@ x-webhooks: type: string enum: - edited - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 changes: type: object @@ -233520,16 +233698,16 @@ x-webhooks: properties: added: type: array - items: *727 + items: *729 deleted: type: array - items: *727 + items: *729 updated: type: array items: type: object properties: - rule: *727 + rule: *729 changes: type: object properties: @@ -233763,10 +233941,10 @@ x-webhooks: - from required: - owner - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233844,10 +234022,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233925,7 +234103,7 @@ x-webhooks: type: string enum: - create - alert: &922 + alert: &924 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -234046,10 +234224,10 @@ x-webhooks: type: string enum: - open - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234255,10 +234433,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234336,11 +234514,11 @@ x-webhooks: type: string enum: - reopen - alert: *922 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *924 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234539,10 +234717,10 @@ x-webhooks: enum: - fixed - open - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234620,7 +234798,7 @@ x-webhooks: type: string enum: - created - alert: &923 + alert: &925 type: object properties: number: *123 @@ -234738,10 +234916,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234822,11 +235000,11 @@ x-webhooks: type: string enum: - created - alert: *923 - installation: *857 - location: *924 - organization: *858 - repository: *859 + alert: *925 + installation: *859 + location: *926 + organization: *860 + repository: *861 sender: *4 required: - location @@ -235064,11 +235242,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235146,11 +235324,11 @@ x-webhooks: type: string enum: - reopened - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235228,11 +235406,11 @@ x-webhooks: type: string enum: - resolved - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235310,11 +235488,11 @@ x-webhooks: type: string enum: - validated - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235440,10 +235618,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *859 - enterprise: *856 - installation: *857 - organization: *858 + repository: *861 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -235521,11 +235699,11 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - security_advisory: &925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + security_advisory: &927 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235708,11 +235886,11 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - security_advisory: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + security_advisory: *927 sender: *4 required: - action @@ -235785,10 +235963,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235972,11 +236150,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *412 - enterprise: *856 - installation: *857 - organization: *858 - repository: *479 + security_and_analysis: *415 + enterprise: *858 + installation: *859 + organization: *860 + repository: *480 sender: *4 required: - changes @@ -236054,12 +236232,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: &926 + sponsorship: &928 type: object properties: created_at: @@ -236360,12 +236538,12 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - sponsorship @@ -236453,12 +236631,12 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236535,17 +236713,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &927 + effective_date: &929 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: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - sponsorship @@ -236619,7 +236797,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &928 + changes: &930 type: object properties: tier: @@ -236663,13 +236841,13 @@ x-webhooks: - from required: - tier - effective_date: *927 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + effective_date: *929 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236746,13 +236924,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *928 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + changes: *930 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236826,10 +237004,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236912,10 +237090,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -237335,15 +237513,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *856 + enterprise: *858 id: description: The unique identifier of the status. type: integer - installation: *857 + installation: *859 name: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 sha: description: The Commit SHA. @@ -237452,15 +237630,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 + parent_issue: *227 parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 - installation: *857 - organization: *858 - repository: *859 + sub_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237544,15 +237722,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 + parent_issue: *227 parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 - installation: *857 - organization: *858 - repository: *859 + sub_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237636,15 +237814,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 + sub_issue: *227 sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 - installation: *857 - organization: *858 - repository: *859 + parent_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237728,15 +237906,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 + sub_issue: *227 sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 - installation: *857 - organization: *858 - repository: *859 + parent_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237813,12 +237991,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - team: &929 + team: &931 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -238041,9 +238219,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -238501,7 +238679,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -238577,9 +238755,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -239037,7 +239215,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -239114,9 +239292,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -239574,7 +239752,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -239718,9 +239896,9 @@ x-webhooks: - from required: - permissions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -240178,7 +240356,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - changes @@ -240256,9 +240434,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -240716,7 +240894,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -240792,10 +240970,10 @@ x-webhooks: type: string enum: - started - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -240868,16 +241046,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *856 + enterprise: *858 inputs: type: object nullable: true additionalProperties: true - installation: *857 - organization: *858 + installation: *859 + organization: *860 ref: type: string - repository: *859 + repository: *861 sender: *4 workflow: type: string @@ -240959,10 +241137,10 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: allOf: @@ -241199,7 +241377,7 @@ x-webhooks: type: string required: - conclusion - deployment: *611 + deployment: *612 required: - action - repository @@ -241278,10 +241456,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: allOf: @@ -241541,7 +241719,7 @@ x-webhooks: required: - status - steps - deployment: *611 + deployment: *612 required: - action - repository @@ -241620,10 +241798,10 @@ x-webhooks: type: string enum: - queued - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: type: object @@ -241758,7 +241936,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *611 + deployment: *612 required: - action - repository @@ -241837,10 +242015,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: type: object @@ -241976,7 +242154,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *611 + deployment: *612 required: - action - repository @@ -242056,12 +242234,12 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object @@ -243060,12 +243238,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object @@ -244049,12 +244227,12 @@ x-webhooks: type: string enum: - requested - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 902af3878..a8e033fd7 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -61502,6 +61502,1753 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to retrieve budget.", + "documentation_url": "https://docs.github.com/rest/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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -64193,7 +65940,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" @@ -64201,7 +65948,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": [ { @@ -64288,7 +66035,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -96776,6 +98523,1264 @@ } } }, + "/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", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", + "example": "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Budget not found or feature not enabled", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "budget-not-found": { + "value": { + "message": "Budget with ID 550e8400-e29b-41d4-a716-446655440000 not found.", + "documentation_url": "https://docs.github.com/rest/billing/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", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Internal server error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "server-error": { + "value": { + "message": "Unable to 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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "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", @@ -97457,7 +100462,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" @@ -97465,7 +100470,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": [ { @@ -97534,7 +100539,7 @@ ], "responses": { "200": { - "description": "Response when getting a billing usage summary report", + "description": "Response when getting a billing usage summary", "content": { "application/json": { "schema": { @@ -179050,847 +182055,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -234497,965 +236661,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -464819,1245 +466024,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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "nullable": true - }, - "documentation_url": { - "type": "string", - "nullable": true - }, - "detail": { - "type": "string", - "nullable": true - }, - "status": { - "type": "integer" - }, - "scimType": { - "type": "string", - "nullable": true - }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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": { @@ -466079,21 +466116,94 @@ } } } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": "string", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } } } + } + }, + "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" @@ -466101,7 +466211,41 @@ "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { "type": "array", "items": { "type": "string" @@ -466116,12 +466260,112 @@ "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", + "nullable": true + }, + "documentation_url": { + "type": "string", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": "string", + "nullable": true + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "repos" + } } }, "/repos/{owner}/{repo}/properties/values": { @@ -523206,8 +523450,12 @@ "nullable": true } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -619796,416 +620044,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", @@ -650975,421 +650813,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "nullable": true, - "type": "string" - }, - "email": { - "nullable": true, - "type": "string" - }, - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "format": "int64", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - }, - "user_view_type": { - "type": "string", - "example": "public" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "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", @@ -674565,7 +673988,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" @@ -674573,7 +673996,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": [ { @@ -674642,7 +674065,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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 9882bdc41..dad162cce 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -865,7 +865,7 @@ paths: - subscriptions_url - type - url - type: &432 + type: &435 type: string description: The type of credit the user is receiving. enum: @@ -998,7 +998,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &256 + schema: &260 title: Validation Error Simple description: Validation Error Simple type: object @@ -1031,7 +1031,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &761 + - &763 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1149,7 +1149,7 @@ paths: GitHub. type: object nullable: true - properties: &211 + properties: &212 id: description: Unique identifier of the GitHub app example: 37 @@ -1282,7 +1282,7 @@ paths: about itself. example: 5 type: integer - required: &212 + required: &213 - id - node_id - owner @@ -1587,7 +1587,7 @@ paths: schema: type: integer default: 30 - - &342 + - &346 name: cursor description: 'Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous @@ -1603,7 +1603,7 @@ paths: application/json: schema: type: array - items: &343 + items: &347 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1683,7 +1683,7 @@ paths: - installation_id - repository_id examples: - default: &344 + default: &348 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1715,7 +1715,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &771 + schema: &773 title: Scim Error description: Scim Error type: object @@ -1742,7 +1742,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &255 + schema: &259 title: Validation Error description: Validation Error type: object @@ -1811,7 +1811,7 @@ paths: description: Response content: application/json: - schema: &345 + schema: &349 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1925,7 +1925,7 @@ paths: - request - response examples: - default: &346 + default: &350 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2126,7 +2126,7 @@ paths: parameters: - *17 - *19 - - &216 + - &217 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) @@ -2892,7 +2892,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &410 + properties: &413 id: description: Unique identifier of the repository example: 42 @@ -2912,7 +2912,7 @@ paths: title: License Simple description: License Simple type: object - properties: &227 + properties: &228 key: type: string example: mit @@ -2934,7 +2934,7 @@ paths: html_url: type: string format: uri - required: &228 + required: &229 - key - name - url @@ -3330,7 +3330,7 @@ paths: type: boolean lexical_commit_sha: type: string - required: &411 + required: &414 - archive_url - assignees_url - blobs_url @@ -7487,7 +7487,7 @@ paths: description: Response content: application/json: - schema: &257 + schema: &261 type: object properties: total_active_caches_count: @@ -7502,7 +7502,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &258 + default: &262 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7695,7 +7695,7 @@ paths: - public_ip_enabled - platform examples: - default: &259 + default: &263 value: total_count: 2 runners: @@ -7990,7 +7990,7 @@ paths: application/json: schema: *45 examples: - default: &260 + default: &264 value: id: 1 platform: linux-x64 @@ -8130,7 +8130,7 @@ paths: application/json: schema: *48 examples: - default: &261 + default: &265 value: version: 1.0.0 size_gb: 75 @@ -8294,7 +8294,7 @@ paths: description: Response content: application/json: - schema: &262 + schema: &266 type: object properties: public_ips: @@ -8319,7 +8319,7 @@ paths: required: - public_ips examples: - default: &263 + default: &267 value: public_ips: current_usage: 17 @@ -8359,7 +8359,7 @@ paths: type: array items: *52 examples: - default: &264 + default: &268 value: id: 4-core cpu_cores: 4 @@ -8621,7 +8621,7 @@ paths: - all - local_only - selected - selected_actions_url: &267 + selected_actions_url: &271 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` @@ -8701,7 +8701,7 @@ paths: description: Successfully retrieved the artifact and log retention settings content: application/json: - schema: &269 + schema: &273 type: object properties: days: @@ -8719,7 +8719,7 @@ paths: value: days: 90 maximum_allowed_days: 365 - '401': &772 + '401': &774 description: Authorization failure '404': *6 x-github: @@ -8747,7 +8747,7 @@ paths: required: true content: application/json: - schema: &270 + schema: &274 type: object properties: days: @@ -8796,7 +8796,7 @@ paths: required: - approval_policy examples: - default: &271 + default: &275 value: approval_policy: first_time_contributors '404': *6 @@ -8854,7 +8854,7 @@ paths: description: Response content: application/json: - schema: &272 + schema: &276 type: object required: - run_workflows_from_fork_pull_requests @@ -8908,7 +8908,7 @@ paths: required: true content: application/json: - schema: &273 + schema: &277 type: object required: - run_workflows_from_fork_pull_requests @@ -9331,7 +9331,7 @@ paths: description: Success response content: application/json: - schema: &276 + schema: &280 type: object properties: default_workflow_permissions: &63 @@ -9379,7 +9379,7 @@ paths: required: true content: application/json: - schema: &277 + schema: &281 type: object properties: default_workflow_permissions: *63 @@ -10215,7 +10215,7 @@ paths: application/json: schema: type: array - items: &281 + items: &285 title: Runner Application description: Runner Application type: object @@ -10240,7 +10240,7 @@ paths: - download_url - filename examples: - default: &282 + default: &286 value: - os: osx architecture: x64 @@ -10324,7 +10324,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &283 + '201': &287 description: Response content: application/json: @@ -10439,7 +10439,7 @@ paths: - token - expires_at examples: - default: &284 + default: &288 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -10479,7 +10479,7 @@ paths: application/json: schema: *75 examples: - default: &285 + default: &289 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -10511,7 +10511,7 @@ paths: application/json: schema: *72 examples: - default: &286 + default: &290 value: id: 23 name: MBP @@ -10727,7 +10727,7 @@ paths: - *41 - *71 responses: - '200': &287 + '200': &291 description: Response content: application/json: @@ -10783,7 +10783,7 @@ paths: parameters: - *41 - *71 - - &288 + - &292 name: name description: The name of a self-hosted runner's custom label. in: path @@ -10874,7 +10874,7 @@ paths: required: true content: application/json: - schema: &295 + schema: &299 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -11515,7 +11515,7 @@ paths: required: false schema: type: string - - &296 + - &300 name: include description: |- The event types to include: @@ -11533,7 +11533,7 @@ paths: - web - git - all - - &297 + - &301 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. @@ -11541,7 +11541,7 @@ paths: required: false schema: type: string - - &298 + - &302 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. @@ -11549,7 +11549,7 @@ paths: required: false schema: type: string - - &299 + - &303 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -11571,7 +11571,7 @@ paths: application/json: schema: type: array - items: &300 + items: &304 type: object properties: "@timestamp": @@ -11693,7 +11693,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &301 + default: &305 value: - "@timestamp": 1606929874512 action: team.add_member @@ -12359,7 +12359,7 @@ paths: application/json: schema: type: array - items: &302 + items: &306 title: Push rule bypass request description: A bypass request made by a user asking to be exempted from a push rule in this repository. @@ -12520,7 +12520,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &303 + default: &307 value: - id: 21 number: 42 @@ -12625,7 +12625,7 @@ paths: application/json: schema: type: array - items: &305 + items: &309 title: Secret scanning bypass request description: A bypass request made by a user asking to be exempted from push protection in this repository. @@ -12750,7 +12750,7 @@ paths: format: uri example: https://github.com/octo-org/smile/exemptions/1 examples: - default: &306 + default: &310 value: - id: 21 number: 42 @@ -12835,7 +12835,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *41 - - &311 + - &315 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`, @@ -12845,7 +12845,7 @@ paths: schema: &107 type: string description: The name of the tool used to generate the code scanning analysis. - - &312 + - &316 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 @@ -12868,7 +12868,7 @@ paths: be returned. in: query required: false - schema: &313 + schema: &317 type: string description: State of a code scanning alert. enum: @@ -12893,7 +12893,7 @@ paths: application/json: schema: type: array - items: &314 + items: &318 type: object properties: number: &123 @@ -12922,7 +12922,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &547 + instances_url: &548 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -12957,7 +12957,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &548 + dismissed_reason: &549 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -12966,13 +12966,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &549 + dismissed_comment: &550 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &550 + rule: &551 type: object properties: id: @@ -13025,7 +13025,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &551 + tool: &552 type: object properties: name: *107 @@ -13035,15 +13035,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *108 - most_recent_instance: &552 + most_recent_instance: &553 type: object properties: - ref: &545 + ref: &546 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &562 + analysis_key: &563 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -13054,7 +13054,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &563 + category: &564 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -13103,7 +13103,7 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: &244 + properties: &245 id: type: integer format: int64 @@ -13330,7 +13330,7 @@ paths: format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks description: The API URL to list the hooks on the repository. - required: &245 + required: &246 - archive_url - assignees_url - blobs_url @@ -13402,7 +13402,7 @@ paths: - most_recent_instance - repository examples: - default: &315 + default: &319 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -14055,7 +14055,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &316 + code_scanning_options: &320 type: object description: Security Configuration feature options for code scanning nullable: true @@ -14249,7 +14249,7 @@ paths: description: Response content: application/json: - schema: &318 + schema: &322 type: array description: A list of default code security configurations items: @@ -14265,7 +14265,7 @@ paths: default configuration: *110 examples: - default: &319 + default: &323 value: - default_for_new_repos: public configuration: @@ -14719,7 +14719,7 @@ paths: default: value: default_for_new_repos: all - configuration: &317 + configuration: &321 value: id: 1325 target_type: organization @@ -14804,7 +14804,7 @@ paths: application/json: schema: type: array - items: &320 + items: &324 type: object description: Repositories associated with a code security configuration and attachment status @@ -14828,7 +14828,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &321 + repository: &325 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -15317,7 +15317,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &307 + - &311 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -15392,7 +15392,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &377 + properties: &381 id: description: Unique identifier of the team type: integer @@ -15464,7 +15464,7 @@ paths: description: Unique identifier of the enterprise to which this team belongs example: 42 - required: &378 + required: &382 - id - node_id - url @@ -16052,7 +16052,7 @@ paths: application/json: schema: type: array - items: &201 + items: &202 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -16359,7 +16359,7 @@ paths: - date additionalProperties: true examples: - default: &202 + default: &203 value: - date: '2024-06-24' total_active_users: 24 @@ -16461,7 +16461,7 @@ paths: '500': *40 '403': *29 '404': *6 - '422': &203 + '422': &204 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -16697,7 +16697,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *41 - - &327 + - &331 name: state in: query description: |- @@ -16706,7 +16706,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &328 + - &332 name: severity in: query description: |- @@ -16715,7 +16715,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &329 + - &333 name: ecosystem in: query description: |- @@ -16724,14 +16724,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &330 + - &334 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 - - &331 + - &335 name: epss_percentage in: query description: |- @@ -16743,7 +16743,7 @@ paths: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string - - &602 + - &603 name: has in: query description: |- @@ -16757,7 +16757,7 @@ paths: type: string enum: - patch - - &332 + - &336 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -16767,7 +16767,7 @@ paths: enum: - development - runtime - - &333 + - &337 name: sort in: query description: |- @@ -16793,7 +16793,7 @@ paths: application/json: schema: type: array - items: &334 + items: &338 type: object description: A Dependabot alert. properties: @@ -16856,7 +16856,7 @@ paths: - unknown - direct - transitive - security_advisory: &603 + security_advisory: &604 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -17088,7 +17088,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: &604 + auto_dismissed_at: &605 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -17114,7 +17114,7 @@ paths: - repository additionalProperties: false examples: - default: &335 + default: &339 value: - number: 2 state: dismissed @@ -17895,7 +17895,7 @@ paths: type: array items: *140 examples: - default: &204 + default: &205 value: - id: 1 name: Justice League @@ -18226,7 +18226,7 @@ paths: - name - created_on examples: - default: &443 + default: &446 value: total_count: 2 network_configurations: @@ -18449,7 +18449,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-enterprise parameters: - *41 - - &444 + - &447 name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -18461,7 +18461,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &448 title: Hosted compute network settings resource description: A hosted compute network settings resource. type: object @@ -18495,7 +18495,7 @@ paths: - subnet_id - region examples: - default: &446 + default: &449 value: id: 220F78DACB92BBFBC5E6F22DE1CCF52309D network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 @@ -19295,7 +19295,7 @@ paths: required: true content: application/json: - schema: &409 + schema: &412 title: Custom Property Set Payload description: Custom property set payload type: object @@ -20414,7 +20414,7 @@ paths: nullable: true anyOf: - *157 - - &415 + - &418 title: Organization ruleset conditions type: object description: |- @@ -20461,7 +20461,7 @@ paths: - *160 rules: type: array - items: &727 + items: &729 title: Repository Rule type: object description: A repository rule. @@ -20470,7 +20470,7 @@ paths: - *166 - *167 - *168 - - &724 + - &726 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -20564,7 +20564,7 @@ paths: - *182 - *183 - *184 - - &725 + - &727 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review. @@ -20820,7 +20820,7 @@ paths: type: string format: date-time examples: - default: &418 + default: &421 value: - version_id: 3 actor: @@ -20873,7 +20873,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &422 allOf: - *189 - type: object @@ -20928,7 +20928,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *41 - - &420 + - &423 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -20939,7 +20939,7 @@ paths: enum: - open - resolved - - &421 + - &424 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -20949,7 +20949,7 @@ paths: required: false schema: type: string - - &422 + - &425 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -20958,7 +20958,7 @@ paths: required: false schema: type: string - - &423 + - &426 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. @@ -20974,7 +20974,7 @@ paths: - *17 - *104 - *105 - - &424 + - &427 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -20983,7 +20983,7 @@ paths: required: false schema: type: string - - &425 + - &428 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -20992,7 +20992,7 @@ paths: schema: type: boolean default: false - - &426 + - &429 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -21001,7 +21001,7 @@ paths: schema: type: boolean default: false - - &427 + - &430 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -21017,7 +21017,7 @@ paths: application/json: schema: type: array - items: &428 + items: &431 type: object properties: number: *123 @@ -21036,14 +21036,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &739 + state: &741 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: &740 + resolution: &742 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -21150,8 +21150,8 @@ paths: pull request. ' - oneOf: &741 - - &743 + oneOf: &743 + - &745 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -21203,7 +21203,7 @@ paths: - blob_url - commit_sha - commit_url - - &744 + - &746 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. @@ -21258,7 +21258,7 @@ paths: - page_url - commit_sha - commit_url - - &745 + - &747 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -21272,7 +21272,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &746 + - &748 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -21286,7 +21286,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &747 + - &749 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -21300,7 +21300,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &748 + - &750 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -21314,7 +21314,7 @@ paths: example: https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &749 + - &751 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -21328,7 +21328,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &750 + - &752 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -21342,7 +21342,7 @@ paths: example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &751 + - &753 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. @@ -21356,7 +21356,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &752 + - &754 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. @@ -21370,7 +21370,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &753 + - &755 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. @@ -21384,7 +21384,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &754 + - &756 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. @@ -21398,7 +21398,7 @@ paths: example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &755 + - &757 description: Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. @@ -21425,7 +21425,7 @@ paths: required: *21 nullable: true examples: - default: &429 + default: &432 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -21634,7 +21634,7 @@ paths: description: Response content: application/json: - schema: &430 + schema: &433 title: Secret scanning pattern configuration description: A collection of secret scanning patterns and their settings related to push protection. @@ -21717,7 +21717,7 @@ paths: description: Overrides for custom patterns defined by the organization. items: *191 examples: - default: &431 + default: &434 value: pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K provider_pattern_overrides: @@ -21861,7 +21861,7 @@ paths: description: Response content: application/json: - schema: &434 + schema: &437 type: object properties: total_minutes_used: @@ -21931,7 +21931,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &435 + default: &438 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -21962,7 +21962,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise parameters: - *41 - - &436 + - &439 name: advanced_security_product in: query description: | @@ -21982,7 +21982,7 @@ paths: description: Success content: application/json: - schema: &437 + schema: &440 type: object properties: total_advanced_security_committers: @@ -22037,7 +22037,7 @@ paths: required: - repositories examples: - default: &438 + default: &441 value: total_advanced_security_committers: 2 total_count: 2 @@ -22064,6 +22064,698 @@ 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: + - *41 + responses: + '200': &247 + 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 + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + 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 + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, + repository, cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise + does not require a name). + example: 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 + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - 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': *29 + 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: + - *41 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + example: 100.0 + minimum: 0.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - mona + - lisa + required: + - message + - budget + examples: + create-budget: + value: + message: Budget successfully created. + '400': *14 + '401': *25 + '403': *29 + '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: + - *41 + - &193 + name: budget_id + description: The ID corresponding to the budget. + in: path + required: true + schema: + type: string + responses: + '200': &248 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: 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 + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - 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': *29 + '500': *40 + '503': *190 + 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 + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: number + format: float + description: The budget amount in dollars + example: 100.0 + minimum: 0.0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + example: + - mona + - lisa + required: + - budget + - message + examples: + update-budget: + value: + message: Budget successfully updated. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + '400': *14 + '401': *25 + '403': *29 + '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: + - *41 + - *193 + responses: + '200': &249 + 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': *29 + '500': *40 + '503': *190 + 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 @@ -22286,7 +22978,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-a-cost-center-by-id parameters: - *41 - - &195 + - &196 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -22298,7 +22990,7 @@ paths: description: Response when getting a cost center content: application/json: - schema: &193 + schema: &194 type: object properties: id: @@ -22337,7 +23029,7 @@ paths: - name - resources examples: - default: &194 + default: &195 value: id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name @@ -22401,9 +23093,9 @@ paths: description: Response when updating a cost center content: application/json: - schema: *193 + schema: *194 examples: - default: *194 + default: *195 '400': *14 '403': *29 '404': *6 @@ -22427,7 +23119,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#delete-a-cost-center parameters: - *41 - - *195 + - *196 responses: '200': description: Response when deleting a cost center @@ -22487,7 +23179,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-resources-to-a-cost-center parameters: - *41 - - *195 + - *196 requestBody: required: true content: @@ -22579,7 +23271,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-resources-from-a-cost-center parameters: - *41 - - *195 + - *196 requestBody: required: true content: @@ -22657,7 +23349,7 @@ paths: description: Response content: application/json: - schema: &439 + schema: &442 type: object properties: total_gigabytes_bandwidth_used: @@ -22675,7 +23367,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &440 + default: &443 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -22700,7 +23392,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-premium-request-usage-report-for-an-enterprise parameters: - *41 - - &196 + - &197 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, @@ -22709,7 +23401,7 @@ paths: required: false schema: type: integer - - &198 + - &199 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 @@ -22718,7 +23410,7 @@ paths: required: false schema: type: integer - - &197 + - &198 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 @@ -22727,7 +23419,7 @@ paths: required: false schema: type: integer - - &199 + - &200 name: organization description: The organization name to query usage for. The name is not case sensitive. @@ -22735,21 +23427,21 @@ paths: required: false schema: type: string - - &246 + - &250 name: user description: The user name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &247 + - &251 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &200 + - &201 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -22919,7 +23611,7 @@ paths: description: Response content: application/json: - schema: &441 + schema: &444 type: object properties: days_left_in_billing_cycle: @@ -22937,7 +23629,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &442 + default: &445 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -22962,8 +23654,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *41 - - *196 - - &248 + - *197 + - &252 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 @@ -22972,7 +23664,7 @@ paths: required: false schema: type: integer - - *197 + - *198 - name: cost_center_id description: The ID corresponding to a cost center. The default value is no cost center. @@ -22985,7 +23677,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &249 + schema: &253 type: object properties: usageItems: @@ -23038,7 +23730,7 @@ paths: - netAmount - organizationName examples: - default: &250 + default: &254 value: usageItems: - date: '2023-08-01' @@ -23063,7 +23755,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. @@ -23076,22 +23768,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: - *41 - - *196 - - *198 - *197 - *199 - - &251 + - *198 + - *200 + - &255 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *200 - - &252 + - *201 + - &256 name: sku description: The SKU to query for usage. in: query @@ -23107,7 +23799,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: @@ -23290,13 +23982,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23325,7 +24017,7 @@ paths: type: array items: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -23402,7 +24094,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23420,7 +24112,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - *41 - - &205 + - &206 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -23439,7 +24131,7 @@ paths: type: array items: *4 examples: - default: &206 + default: &207 value: - login: octocat id: 1 @@ -23478,7 +24170,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23509,7 +24201,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23527,7 +24219,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23558,7 +24250,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23576,7 +24268,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - *41 - - *205 + - *206 - *138 responses: '200': @@ -23585,7 +24277,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &207 + exampleKey1: &208 value: login: octocat id: 1 @@ -23621,7 +24313,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - *41 - - *205 + - *206 - *138 responses: '201': @@ -23630,7 +24322,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *207 + exampleKey1: *208 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23648,7 +24340,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - *41 - - *205 + - *206 - *138 responses: '204': @@ -23671,7 +24363,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - *41 - - *205 + - *206 - *17 - *19 responses: @@ -23683,7 +24375,7 @@ paths: type: array items: *69 examples: - default: &208 + default: &209 value: login: github id: 1 @@ -23714,7 +24406,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23744,7 +24436,7 @@ paths: type: array items: *69 examples: - default: &243 + default: &244 value: - login: github id: 1 @@ -23775,7 +24467,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - *41 - - *205 + - *206 requestBody: required: true content: @@ -23816,7 +24508,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '200': @@ -23825,7 +24517,7 @@ paths: application/json: schema: *69 examples: - default: *208 + default: *209 '404': description: The team is not assigned to the organization x-github: @@ -23844,7 +24536,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '201': @@ -23853,7 +24545,7 @@ paths: application/json: schema: *69 examples: - default: *208 + default: *209 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23870,7 +24562,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - *41 - - *205 + - *206 - *83 responses: '204': @@ -23895,7 +24587,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - *41 - - &209 + - &210 name: team_slug description: The slug of the team name. in: path @@ -23909,7 +24601,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -23929,7 +24621,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - *41 - - *209 + - *210 requestBody: required: true content: @@ -23986,7 +24678,7 @@ paths: application/json: schema: *140 examples: - default: *204 + default: *205 headers: Link: *43 '403': *29 @@ -24009,7 +24701,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - *41 - - *209 + - *210 responses: '204': description: Response @@ -24108,7 +24800,7 @@ paths: application/json: schema: type: array - items: &238 + items: &239 title: Event description: Event type: object @@ -24118,7 +24810,7 @@ paths: type: type: string nullable: true - actor: &210 + actor: &211 title: Actor description: Actor type: object @@ -24158,18 +24850,18 @@ paths: - id - name - url - org: *210 + org: *211 payload: type: object properties: action: type: string - issue: &226 + issue: &227 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &661 + properties: &663 id: type: integer format: int64 @@ -24281,7 +24973,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &401 + properties: &404 url: type: string format: uri @@ -24351,7 +25043,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &402 + required: &405 - closed_issues - creator - description @@ -24430,7 +25122,7 @@ paths: timeline_url: type: string format: uri - type: &364 + type: &368 title: Issue Type description: The type of issue. type: object @@ -24489,9 +25181,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - author_association: &213 + properties: *212 + required: *213 + author_association: &214 title: author_association type: string example: OWNER @@ -24505,7 +25197,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &214 + reactions: &215 title: Reaction Rollup type: object properties: @@ -24541,7 +25233,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &799 + sub_issues_summary: &801 title: Sub-issues Summary type: object properties: @@ -24561,7 +25253,7 @@ paths: type: string format: uri nullable: true - issue_dependencies_summary: &800 + issue_dependencies_summary: &802 title: Issue Dependencies Summary type: object properties: @@ -24580,7 +25272,7 @@ paths: - total_blocking issue_field_values: type: array - items: &801 + items: &803 title: Issue Field Value description: A value assigned to an issue field type: object @@ -24640,7 +25332,7 @@ paths: - node_id - data_type - value - required: &662 + required: &664 - assignee - closed_at - comments @@ -24661,7 +25353,7 @@ paths: - user - created_at - updated_at - comment: &659 + comment: &661 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -24709,7 +25401,7 @@ paths: issue_url: type: string format: uri - author_association: *213 + author_association: *214 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -24719,9 +25411,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - id - node_id @@ -24888,7 +25580,7 @@ paths: _links: type: object properties: - timeline: &215 + timeline: &216 title: Link With Type description: Hypermedia Link with Type type: object @@ -24900,17 +25592,17 @@ paths: required: - href - type - user: *215 - security_advisories: *215 - current_user: *215 - current_user_public: *215 - current_user_actor: *215 - current_user_organization: *215 + user: *216 + security_advisories: *216 + current_user: *216 + current_user_public: *216 + current_user_actor: *216 + current_user_organization: *216 current_user_organizations: type: array - items: *215 - repository_discussions: *215 - repository_discussions_category: *215 + items: *216 + repository_discussions: *216 + repository_discussions_category: *216 required: - timeline - user @@ -24972,7 +25664,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *216 + - *217 - *17 - *19 responses: @@ -24982,7 +25674,7 @@ paths: application/json: schema: type: array - items: &217 + items: &218 title: Base Gist description: Base Gist type: object @@ -25081,7 +25773,7 @@ paths: - created_at - updated_at examples: - default: &218 + default: &219 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -25202,7 +25894,7 @@ paths: description: Response content: application/json: - schema: &219 + schema: &220 title: Gist Simple description: Gist Simple type: object @@ -25219,7 +25911,7 @@ paths: url: type: string format: uri - user: &813 + user: &815 title: Public User description: Public User type: object @@ -25581,7 +26273,7 @@ paths: truncated: type: boolean examples: - default: &220 + default: &221 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -25685,7 +26377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *216 + - *217 - *17 - *19 responses: @@ -25695,9 +26387,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '422': *15 @@ -25719,7 +26411,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *216 + - *217 - *17 - *19 responses: @@ -25729,9 +26421,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '401': *25 @@ -25759,7 +26451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &221 + - &222 name: gist_id description: The unique identifier of the gist. in: path @@ -25771,10 +26463,10 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - default: *220 - '403': &224 + default: *221 + '403': &225 description: Forbidden Gist content: application/json: @@ -25822,7 +26514,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *221 + - *222 requestBody: required: true content: @@ -25882,9 +26574,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - updateGist: *220 + updateGist: *221 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -26042,7 +26734,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26071,7 +26763,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26081,7 +26773,7 @@ paths: application/json: schema: type: array - items: &222 + items: &223 title: Gist Comment description: A comment made to a gist. type: object @@ -26116,7 +26808,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *213 + author_association: *214 required: - url - id @@ -26181,7 +26873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *221 + - *222 requestBody: required: true content: @@ -26206,9 +26898,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: &223 + default: &224 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -26266,8 +26958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *221 - - &225 + - *222 + - &226 name: comment_id description: The unique identifier of the comment. in: path @@ -26280,12 +26972,12 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *223 + default: *224 '304': *37 '404': *6 - '403': *224 + '403': *225 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -26307,8 +26999,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *221 - - *225 + - *222 + - *226 requestBody: required: true content: @@ -26333,9 +27025,9 @@ paths: description: Response content: application/json: - schema: *222 + schema: *223 examples: - default: *223 + default: *224 '404': *6 x-github: githubCloudOnly: false @@ -26352,8 +27044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *221 - - *225 + - *222 + - *226 responses: '204': description: Response @@ -26376,7 +27068,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26477,7 +27169,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *221 + - *222 - *17 - *19 responses: @@ -26487,7 +27179,7 @@ paths: application/json: schema: type: array - items: *219 + items: *220 examples: default: value: @@ -26552,13 +27244,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *221 + - *222 responses: '201': description: Response content: application/json: - schema: *217 + schema: *218 examples: default: value: @@ -26629,7 +27321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *221 + - *222 responses: '204': description: Response if gist is starred @@ -26659,7 +27351,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26681,7 +27373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *221 + - *222 responses: '204': description: Response @@ -26710,7 +27402,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *221 + - *222 - name: sha in: path required: true @@ -26721,9 +27413,9 @@ paths: description: Response content: application/json: - schema: *219 + schema: *220 examples: - default: *220 + default: *221 '422': *15 '404': *6 '403': *29 @@ -27089,7 +27781,7 @@ paths: - closed - all default: open - - &367 + - &371 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -27108,7 +27800,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - name: collab in: query required: false @@ -27138,9 +27830,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: &368 + default: &372 value: - id: 1 node_id: MDU6SXNzdWUx @@ -27424,8 +28116,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 examples: default: value: @@ -27710,7 +28402,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &229 + X-CommonMarker-Version: &230 example: 0.17.4 schema: type: string @@ -27765,7 +28457,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *229 + X-CommonMarker-Version: *230 content: text/html: schema: @@ -27794,7 +28486,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: - - &232 + - &233 name: account_id description: account_id parameter in: path @@ -27806,7 +28498,7 @@ paths: description: Response content: application/json: - schema: &231 + schema: &232 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -27836,7 +28528,7 @@ paths: nullable: true id: type: integer - plan: &230 + plan: &231 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -27925,7 +28617,7 @@ paths: nullable: true updated_at: type: string - plan: *230 + plan: *231 required: - url - id @@ -27933,7 +28625,7 @@ paths: - login - marketplace_purchase examples: - default: &233 + default: &234 value: url: https://api.github.com/orgs/github type: Organization @@ -28018,9 +28710,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: &234 + default: &235 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -28060,14 +28752,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &235 + - &236 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &236 + - &237 name: sort description: The property to sort the results by. in: query @@ -28097,9 +28789,9 @@ paths: application/json: schema: type: array - items: *231 + items: *232 examples: - default: &237 + default: &238 value: - url: https://api.github.com/orgs/github type: Organization @@ -28173,15 +28865,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: - - *232 + - *233 responses: '200': description: Response content: application/json: - schema: *231 + schema: *232 examples: - default: *233 + default: *234 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -28213,9 +28905,9 @@ paths: application/json: schema: type: array - items: *230 + items: *231 examples: - default: *234 + default: *235 headers: Link: *43 '401': *25 @@ -28238,8 +28930,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *235 - *236 + - *237 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -28259,9 +28951,9 @@ paths: application/json: schema: type: array - items: *231 + items: *232 examples: - default: *237 + default: *238 headers: Link: *43 '401': *25 @@ -28525,14 +29217,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: - - &466 + - &469 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &467 + - &470 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -28549,7 +29241,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -28594,7 +29286,7 @@ paths: '404': *6 '403': *29 '304': *37 - '301': &480 + '301': &481 description: Moved permanently content: application/json: @@ -28616,7 +29308,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &691 + - &693 name: all description: If `true`, show notifications marked as read. in: query @@ -28624,7 +29316,7 @@ paths: schema: type: boolean default: false - - &692 + - &694 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -28633,8 +29325,8 @@ paths: schema: type: boolean default: false - - *216 - - &693 + - *217 + - &695 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: @@ -28659,18 +29351,18 @@ paths: application/json: schema: type: array - items: &239 + items: &240 title: Thread description: Thread type: object properties: id: type: string - repository: &280 + repository: &284 title: Minimal Repository description: Minimal Repository type: object - properties: &337 + properties: &341 id: type: integer format: int64 @@ -28946,7 +29638,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &412 + security_and_analysis: &415 nullable: true type: object properties: @@ -29028,7 +29720,7 @@ paths: the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true - required: &338 + required: &342 - archive_url - assignees_url - blobs_url @@ -29116,7 +29808,7 @@ paths: - url - subscription_url examples: - default: &694 + default: &696 value: - id: '1' repository: @@ -29282,7 +29974,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &240 + - &241 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 @@ -29296,7 +29988,7 @@ paths: description: Response content: application/json: - schema: *239 + schema: *240 examples: default: value: @@ -29399,7 +30091,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *240 + - *241 responses: '205': description: Reset Content @@ -29422,7 +30114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *240 + - *241 responses: '204': description: No content @@ -29445,13 +30137,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: - - *240 + - *241 responses: '200': description: Response content: application/json: - schema: &241 + schema: &242 title: Thread Subscription description: Thread Subscription type: object @@ -29488,7 +30180,7 @@ paths: - url - subscribed examples: - default: &242 + default: &243 value: subscribed: true ignored: false @@ -29519,7 +30211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *240 + - *241 requestBody: required: false content: @@ -29540,9 +30232,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *242 examples: - default: *242 + default: *243 '304': *37 '403': *29 '401': *25 @@ -29565,7 +30257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *240 + - *241 responses: '204': description: Response @@ -29662,7 +30354,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: example: ; rel="next" @@ -29713,7 +30405,7 @@ paths: type: integer custom_roles: type: array - items: &323 + items: &327 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -29761,7 +30453,7 @@ paths: - created_at - updated_at examples: - default: &324 + default: &328 value: id: 8030 name: Security Engineer @@ -29852,8 +30544,8 @@ paths: title: Simple Repository description: A GitHub repository. type: object - properties: *244 - required: *245 + properties: *245 + required: *246 nullable: true additionalProperties: false examples: @@ -30087,7 +30779,7 @@ paths: type: array items: *151 examples: - default: &700 + default: &702 value: - property_name: environment value: production @@ -30137,7 +30829,7 @@ paths: required: - properties examples: - default: &701 + default: &703 value: properties: - property_name: environment @@ -30158,6 +30850,263 @@ 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: + - *83 + responses: + '200': *247 + '404': *6 + '403': *29 + '500': *40 + 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: + - *83 + - *193 + responses: + '200': *248 + '400': *14 + '404': *6 + '403': *29 + '500': *40 + '503': *190 + 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: + - *83 + - *193 + 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 + example: 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': *25 + '403': *29 + '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: + - *83 + - *193 + responses: + '200': *249 + '400': *14 + '404': *6 + '403': *29 + '500': *40 + '503': *190 + 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 @@ -30173,12 +31122,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization parameters: - *83 - - *196 - - *198 - *197 - - *246 - - *247 - - *200 + - *199 + - *198 + - *250 + - *251 + - *201 responses: '200': description: Response when getting a billing premium request usage report @@ -30310,17 +31259,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - *83 - - *196 - - *248 - *197 + - *252 + - *198 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *249 + schema: *253 examples: - default: *250 + default: *254 '400': *14 '403': *29 '500': *40 @@ -30332,7 +31281,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. @@ -30345,18 +31294,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: - *83 - - *196 - - *198 - *197 - - *251 - - *200 - - *252 + - *199 + - *198 + - *255 + - *201 + - *256 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -30490,7 +31439,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &257 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -30823,7 +31772,7 @@ paths: - updated_at - archived_at examples: - default-response: &254 + default-response: &258 value: login: github id: 1 @@ -31148,17 +32097,17 @@ paths: description: Response content: application/json: - schema: *253 + schema: *257 examples: - default: *254 + default: *258 '422': description: Validation failed content: application/json: schema: oneOf: - - *255 - - *256 + - *259 + - *260 '409': *114 x-github: githubCloudOnly: false @@ -31213,9 +32162,9 @@ paths: description: Response content: application/json: - schema: *257 + schema: *261 examples: - default: *258 + default: *262 headers: Link: *43 x-github: @@ -31256,7 +32205,7 @@ paths: type: integer repository_cache_usages: type: array - items: &485 + items: &486 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -31331,7 +32280,7 @@ paths: type: array items: *44 examples: - default: *259 + default: *263 headers: Link: *43 x-github: @@ -31497,7 +32446,7 @@ paths: application/json: schema: *45 examples: - default: *260 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31589,7 +32538,7 @@ paths: application/json: schema: *48 examples: - default: *261 + default: *265 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31708,9 +32657,9 @@ paths: description: Response content: application/json: - schema: *262 + schema: *266 examples: - default: *263 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31746,7 +32695,7 @@ paths: type: array items: *52 examples: - default: *264 + default: *268 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31934,7 +32883,7 @@ paths: description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &265 + schema: &269 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -31948,7 +32897,7 @@ paths: required: - include_claim_keys examples: - default: &266 + default: &270 value: include_claim_keys: - repo @@ -31975,15 +32924,15 @@ paths: required: true content: application/json: - schema: *265 + schema: *269 examples: - default: *266 + default: *270 responses: '201': description: Empty response content: application/json: - schema: &291 + schema: &295 title: Empty Object description: An object without any properties. type: object @@ -32022,7 +32971,7 @@ paths: schema: type: object properties: - enabled_repositories: &268 + enabled_repositories: &272 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -32036,7 +32985,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *56 - selected_actions_url: *267 + selected_actions_url: *271 sha_pinning_required: *57 required: - enabled_repositories @@ -32078,7 +33027,7 @@ paths: schema: type: object properties: - enabled_repositories: *268 + enabled_repositories: *272 allowed_actions: *56 sha_pinning_required: *57 required: @@ -32114,7 +33063,7 @@ paths: description: Response content: application/json: - schema: *269 + schema: *273 examples: response: summary: Example response @@ -32145,7 +33094,7 @@ paths: required: true content: application/json: - schema: *270 + schema: *274 examples: application/json: value: @@ -32183,7 +33132,7 @@ paths: application/json: schema: *58 examples: - default: *271 + default: *275 '404': *6 x-github: enabledForGitHubApps: true @@ -32240,7 +33189,7 @@ paths: description: Response content: application/json: - schema: *272 + schema: *276 examples: default: *59 '403': *29 @@ -32265,7 +33214,7 @@ paths: required: true content: application/json: - schema: *273 + schema: *277 examples: default: *59 responses: @@ -32317,7 +33266,7 @@ paths: type: array items: *74 examples: - default: &275 + default: &279 value: total_count: 1 repositories: @@ -32502,7 +33451,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - *83 - - &274 + - &278 name: repository_id description: The unique identifier of the repository. in: path @@ -32531,7 +33480,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -32727,7 +33676,7 @@ paths: type: array items: *74 examples: - default: *275 + default: *279 '403': *29 '404': *6 x-github: @@ -32796,7 +33745,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: - *83 - - *274 + - *278 responses: '204': description: No content @@ -32823,7 +33772,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: - *83 - - *274 + - *278 responses: '204': description: No content @@ -32857,7 +33806,7 @@ paths: description: Response content: application/json: - schema: *276 + schema: *280 examples: default: *65 x-github: @@ -32891,7 +33840,7 @@ paths: required: false content: application/json: - schema: *277 + schema: *281 examples: default: *65 x-github: @@ -32938,7 +33887,7 @@ paths: type: number runner_groups: type: array - items: &278 + items: &282 type: object properties: id: @@ -33126,9 +34075,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: &279 + default: &283 value: id: 2 name: octo-runner-group @@ -33170,7 +34119,7 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: default: value: @@ -33261,9 +34210,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *282 examples: - default: *279 + default: *283 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -33327,7 +34276,7 @@ paths: type: array items: *44 examples: - default: *259 + default: *263 headers: Link: *43 x-github: @@ -33368,9 +34317,9 @@ paths: type: number repositories: type: array - items: *280 + items: *284 examples: - default: &816 + default: &818 value: total_count: 1 repositories: @@ -33669,7 +34618,7 @@ paths: parameters: - *83 - *68 - - *274 + - *278 responses: '204': description: Response @@ -33693,7 +34642,7 @@ paths: parameters: - *83 - *68 - - *274 + - *278 responses: '204': description: Response @@ -33911,9 +34860,9 @@ paths: application/json: schema: type: array - items: *281 + items: *285 examples: - default: *282 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33978,7 +34927,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *283 + '201': *287 '404': *6 '422': *7 '409': *114 @@ -34017,7 +34966,7 @@ paths: application/json: schema: *75 examples: - default: *284 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34053,7 +35002,7 @@ paths: application/json: schema: *75 examples: - default: *285 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34084,7 +35033,7 @@ paths: application/json: schema: *72 examples: - default: *286 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34259,7 +35208,7 @@ paths: - *83 - *71 responses: - '200': *287 + '200': *291 '404': *6 x-github: githubCloudOnly: false @@ -34288,7 +35237,7 @@ paths: parameters: - *83 - *71 - - *288 + - *292 responses: '200': *77 '404': *6 @@ -34333,7 +35282,7 @@ paths: type: integer secrets: type: array - items: &289 + items: &293 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -34412,7 +35361,7 @@ paths: description: Response content: application/json: - schema: &505 + schema: &506 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -34441,7 +35390,7 @@ paths: - key_id - key examples: - default: &506 + default: &507 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -34467,7 +35416,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - *83 - - &290 + - &294 name: secret_name description: The name of the secret. in: path @@ -34479,7 +35428,7 @@ paths: description: Response content: application/json: - schema: *289 + schema: *293 examples: default: value: @@ -34510,7 +35459,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -34567,7 +35516,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -34594,7 +35543,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -34621,7 +35570,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -34639,9 +35588,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: &294 + default: &298 value: total_count: 1 repositories: @@ -34734,7 +35683,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -34787,7 +35736,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -34821,7 +35770,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -34854,7 +35803,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - *83 - - &490 + - &491 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)." @@ -34878,7 +35827,7 @@ paths: type: integer variables: type: array - items: &292 + items: &296 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -35011,7 +35960,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -35037,7 +35986,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - *83 - - &293 + - &297 name: name description: The name of the variable. in: path @@ -35049,7 +35998,7 @@ paths: description: Response content: application/json: - schema: *292 + schema: *296 examples: default: value: @@ -35080,7 +36029,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - *83 - - *293 + - *297 requestBody: required: true content: @@ -35143,7 +36092,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - *83 - - *293 + - *297 responses: '204': description: Response @@ -35170,7 +36119,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - *83 - - *293 + - *297 - *19 - *17 responses: @@ -35188,9 +36137,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 '409': description: Response when the visibility of the variable is not set to `selected` @@ -35217,7 +36166,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - *83 - - *293 + - *297 requestBody: required: true content: @@ -35267,7 +36216,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - *83 - - *293 + - *297 - name: repository_id in: path required: true @@ -35302,7 +36251,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - *83 - - *293 + - *297 - name: repository_id in: path required: true @@ -35360,7 +36309,7 @@ paths: required: true content: application/json: - schema: *295 + schema: *299 examples: default: *81 parameters: @@ -35665,12 +36614,12 @@ paths: required: - subject_digests examples: - default: &844 + default: &846 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &845 + withPredicateType: &847 value: subject_digests: - sha256:abc123 @@ -35728,7 +36677,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &846 + default: &848 value: attestations_subject_digests: - sha256:abc: @@ -36077,7 +37026,7 @@ paths: initiator: type: string examples: - default: &519 + default: &520 value: attestations: - bundle: @@ -36203,10 +37152,10 @@ paths: required: false schema: type: string - - *296 - - *297 - - *298 - - *299 + - *300 + - *301 + - *302 + - *303 - *17 responses: '200': @@ -36215,9 +37164,9 @@ paths: application/json: schema: type: array - items: *300 + items: *304 examples: - default: *301 + default: *305 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36246,7 +37195,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36340,7 +37289,7 @@ paths: subcategory: bypass-requests parameters: - *83 - - &304 + - &308 name: repository_name description: The name of the repository to filter on. in: query @@ -36359,9 +37308,9 @@ paths: application/json: schema: type: array - items: *302 + items: *306 examples: - default: *303 + default: *307 '404': *6 '500': *40 "/orgs/{org}/bypass-requests/secret-scanning": @@ -36385,7 +37334,7 @@ paths: subcategory: delegated-bypass parameters: - *83 - - *304 + - *308 - *99 - *100 - *101 @@ -36399,9 +37348,9 @@ paths: application/json: schema: type: array - items: *305 + items: *309 examples: - default: *306 + default: *310 '404': *6 '500': *40 "/orgs/{org}/campaigns": @@ -36428,7 +37377,7 @@ paths: description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &308 + schema: &312 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -36454,7 +37403,7 @@ paths: application/json: schema: type: array - items: &309 + items: &313 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -36485,7 +37434,7 @@ paths: team_managers: description: The campaign team managers type: array - items: *307 + items: *311 published_at: description: The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. @@ -36503,7 +37452,7 @@ paths: type: string format: date-time nullable: true - state: *308 + state: *312 contact_link: description: The contact link of the campaign. type: string @@ -36723,9 +37672,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: &310 + default: &314 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -36808,9 +37757,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: *310 + default: *314 '404': *6 '422': description: Unprocessable Entity @@ -36887,7 +37836,7 @@ paths: type: string format: uri nullable: true - state: *308 + state: *312 examples: default: value: @@ -36897,9 +37846,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *313 examples: - default: *310 + default: *314 '400': description: Bad Request content: @@ -36966,8 +37915,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - *83 - - *311 - - *312 + - *315 + - *316 - *104 - *105 - *19 @@ -36978,7 +37927,7 @@ paths: be returned. in: query required: false - schema: *313 + schema: *317 - name: sort description: The property by which to sort the results. in: query @@ -36994,7 +37943,7 @@ paths: be returned. in: query required: false - schema: &546 + schema: &547 type: string description: Severity of a code scanning alert. enum: @@ -37012,9 +37961,9 @@ paths: application/json: schema: type: array - items: *314 + items: *318 examples: - default: *315 + default: *319 headers: Link: *43 '404': *6 @@ -37229,7 +38178,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *316 + code_scanning_options: *320 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -37372,7 +38321,7 @@ paths: application/json: schema: *110 examples: - default: *317 + default: *321 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37400,9 +38349,9 @@ paths: description: Response content: application/json: - schema: *318 + schema: *322 examples: - default: *319 + default: *323 '304': *37 '403': *29 '404': *6 @@ -37489,7 +38438,7 @@ paths: application/json: schema: *110 examples: - default: *317 + default: *321 '304': *37 '403': *29 '404': *6 @@ -37911,7 +38860,7 @@ paths: default: value: default_for_new_repos: all - configuration: *317 + configuration: *321 '403': *29 '404': *6 x-github: @@ -37964,13 +38913,13 @@ paths: application/json: schema: type: array - items: *320 + items: *324 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *321 + repository: *325 '403': *29 '404': *6 x-github: @@ -38010,7 +38959,7 @@ paths: type: integer codespaces: type: array - items: &369 + items: &373 type: object title: Codespace description: A codespace. @@ -38035,12 +38984,12 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *280 + repository: *284 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &575 + properties: &576 name: type: string description: The name of the machine. @@ -38082,7 +39031,7 @@ paths: - ready - in_progress nullable: true - required: &576 + required: &577 - name - display_name - operating_system @@ -38287,7 +39236,7 @@ paths: - pulls_url - recent_folders examples: - default: &370 + default: &374 value: total_count: 3 codespaces: @@ -38911,7 +39860,7 @@ paths: type: integer secrets: type: array - items: &322 + items: &326 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -38950,7 +39899,7 @@ paths: - updated_at - visibility examples: - default: &577 + default: &578 value: total_count: 2 secrets: @@ -38988,7 +39937,7 @@ paths: description: Response content: application/json: - schema: &578 + schema: &579 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -39017,7 +39966,7 @@ paths: - key_id - key examples: - default: &579 + default: &580 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -39041,15 +39990,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *322 + schema: *326 examples: - default: &581 + default: &582 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -39077,7 +40026,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -39132,7 +40081,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -39159,7 +40108,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -39185,7 +40134,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -39203,9 +40152,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 '404': *6 x-github: githubCloudOnly: false @@ -39228,7 +40177,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -39279,7 +40228,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -39313,7 +40262,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -39902,13 +40851,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40120,7 +41069,7 @@ paths: type: integer custom_roles: type: array - items: *323 + items: *327 examples: default: value: @@ -40212,7 +41161,7 @@ paths: required: true content: application/json: - schema: &325 + schema: &329 type: object properties: name: @@ -40253,9 +41202,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40286,9 +41235,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: true @@ -40316,7 +41265,7 @@ paths: required: true content: application/json: - schema: &326 + schema: &330 type: object properties: name: @@ -40354,9 +41303,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40414,7 +41363,7 @@ paths: required: true content: application/json: - schema: *325 + schema: *329 examples: default: value: @@ -40428,9 +41377,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40467,9 +41416,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '404': *6 x-github: githubCloudOnly: true @@ -40503,7 +41452,7 @@ paths: required: true content: application/json: - schema: *326 + schema: *330 examples: default: value: @@ -40518,9 +41467,9 @@ paths: description: Response content: application/json: - schema: *323 + schema: *327 examples: - default: *324 + default: *328 '422': *15 '404': *6 x-github: @@ -40580,11 +41529,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - *83 - - *327 - - *328 - - *329 - - *330 - *331 + - *332 + - *333 + - *334 + - *335 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -40622,8 +41571,8 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *332 - - *333 + - *336 + - *337 - *106 - *104 - *105 @@ -40635,9 +41584,9 @@ paths: application/json: schema: type: array - items: *334 + items: *338 examples: - default: *335 + default: *339 '304': *37 '400': *14 '403': *29 @@ -40681,7 +41630,7 @@ paths: type: integer secrets: type: array - items: &336 + items: &340 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -40758,7 +41707,7 @@ paths: description: Response content: application/json: - schema: &607 + schema: &608 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -40775,7 +41724,7 @@ paths: - key_id - key examples: - default: &608 + default: &609 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -40799,13 +41748,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: default: value: @@ -40834,7 +41783,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -40893,7 +41842,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -40918,7 +41867,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -40943,7 +41892,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 - *19 - *17 responses: @@ -40961,9 +41910,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40985,7 +41934,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -41036,7 +41985,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -41068,7 +42017,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - *83 - - *290 + - *294 - name: repository_id in: path required: true @@ -41105,7 +42054,7 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - &616 + - &617 name: reviewer description: Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request. @@ -41113,7 +42062,7 @@ paths: required: false schema: type: string - - &617 + - &618 name: requester description: Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal. @@ -41121,7 +42070,7 @@ paths: required: false schema: type: string - - &618 + - &619 name: time_period description: |- The time period to filter by. @@ -41137,7 +42086,7 @@ paths: - week - month default: month - - &619 + - &620 name: request_status description: Filter alert dismissal requests by status. When specified, only requests with this status will be returned. @@ -41152,7 +42101,7 @@ paths: - denied - all default: all - - *304 + - *308 - *17 - *19 responses: @@ -41162,7 +42111,7 @@ paths: application/json: schema: type: array - items: &620 + items: &621 title: Code scanning alert dismissal request description: Alert dismisal request made by a user asking to dismiss a code scanning alert. @@ -41318,7 +42267,7 @@ paths: format: uri example: https://github.com/octo-org/smile/code-scanning/alerts/1 examples: - default: &621 + default: &622 value: - id: 21 number: 42 @@ -41405,11 +42354,11 @@ paths: subcategory: alert-dismissal-requests parameters: - *83 - - *304 + - *308 - *99 - *100 - *101 - - &622 + - &623 name: request_status description: The status of the dismissal request to filter on. When specified, only requests with this status will be returned. @@ -41435,7 +42384,7 @@ paths: application/json: schema: type: array - items: &623 + items: &624 title: Secret scanning alert dismissal request description: A dismissal request made by a user asking to close a secret scanning alert in this repository. @@ -41556,7 +42505,7 @@ paths: format: uri example: https://github.com/octo-org/smile/security/secret-scanning/17 examples: - default: &624 + default: &625 value: - id: 21 number: 42 @@ -41644,7 +42593,7 @@ paths: application/json: schema: type: array - items: &380 + items: &384 title: Package description: A software package type: object @@ -41694,8 +42643,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *337 - required: *338 + properties: *341 + required: *342 nullable: true created_at: type: string @@ -41714,7 +42663,7 @@ paths: - created_at - updated_at examples: - default: &381 + default: &385 value: - id: 197 name: hello_docker @@ -41802,7 +42751,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: 200-response: value: @@ -41901,7 +42850,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &464 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -41982,7 +42931,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &462 + default: &465 value: group_id: '123' group_name: Octocat admins @@ -42037,7 +42986,7 @@ paths: description: Response content: application/json: - schema: &459 + schema: &462 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -42074,7 +43023,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &460 + default: &463 value: groups: - group_id: '123' @@ -42118,7 +43067,7 @@ paths: application/json: schema: type: array - items: &361 + items: &365 title: Organization Invitation description: Organization Invitation type: object @@ -42165,7 +43114,7 @@ paths: - invitation_teams_url - node_id examples: - default: &362 + default: &366 value: - id: 1 login: monalisa @@ -42232,7 +43181,7 @@ paths: application/json: schema: type: array - items: &413 + items: &416 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -42246,7 +43195,7 @@ paths: - name - description examples: - default: &414 + default: &417 value: - name: add_assignee description: Assign or remove a user @@ -42287,7 +43236,7 @@ paths: application/json: schema: type: array - items: &339 + items: &343 title: Org Hook description: Org Hook type: object @@ -42456,9 +43405,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: - default: &340 + default: &344 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -42503,7 +43452,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - *83 - - &341 + - &345 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. @@ -42516,9 +43465,9 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: - default: *340 + default: *344 '404': *6 x-github: githubCloudOnly: false @@ -42540,7 +43489,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - *83 - - *341 + - *345 requestBody: required: false content: @@ -42585,7 +43534,7 @@ paths: description: Response content: application/json: - schema: *339 + schema: *343 examples: default: value: @@ -42625,7 +43574,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - *83 - - *341 + - *345 responses: '204': description: Response @@ -42651,7 +43600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - *83 - - *341 + - *345 responses: '200': description: Response @@ -42680,7 +43629,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - *83 - - *341 + - *345 requestBody: required: false content: @@ -42729,9 +43678,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *17 - - *342 + - *346 responses: '200': description: Response @@ -42739,9 +43688,9 @@ paths: application/json: schema: type: array - items: *343 + items: *347 examples: - default: *344 + default: *348 '400': *14 '422': *15 x-github: @@ -42765,16 +43714,16 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *16 responses: '200': description: Response content: application/json: - schema: *345 + schema: *349 examples: - default: *346 + default: *350 '400': *14 '422': *15 x-github: @@ -42798,7 +43747,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - *83 - - *341 + - *345 - *16 responses: '202': *39 @@ -42825,7 +43774,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - *83 - - *341 + - *345 responses: '204': description: Response @@ -42848,7 +43797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - *83 - - &351 + - &355 name: actor_type in: path description: The type of the actor @@ -42861,14 +43810,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &352 + - &356 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &347 + - &351 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`.' @@ -42876,7 +43825,7 @@ paths: required: true schema: type: string - - &348 + - &352 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) @@ -42970,12 +43919,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - *83 - - *347 - - *348 + - *351 + - *352 - *19 - *17 - *106 - - &357 + - &361 name: sort description: The property to sort the results by. in: query @@ -43054,14 +44003,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - *83 - - *347 - - *348 + - *351 + - *352 responses: '200': description: Response content: application/json: - schema: &349 + schema: &353 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -43077,7 +44026,7 @@ paths: type: integer format: int64 examples: - default: &350 + default: &354 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -43098,23 +44047,23 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - *83 - - &353 + - &357 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *347 - - *348 + - *351 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *350 + default: *354 x-github: enabledForGitHubApps: true category: orgs @@ -43133,18 +44082,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - *83 - - *347 - - *348 - *351 - *352 + - *355 + - *356 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *350 + default: *354 x-github: enabledForGitHubApps: true category: orgs @@ -43162,9 +44111,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - *83 - - *347 - - *348 - - &354 + - *351 + - *352 + - &358 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -43177,7 +44126,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &359 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -43193,7 +44142,7 @@ paths: type: integer format: int64 examples: - default: &356 + default: &360 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -43230,18 +44179,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - *83 - - *353 - - *347 - - *348 - - *354 + - *357 + - *351 + - *352 + - *358 responses: '200': description: Response content: application/json: - schema: *355 + schema: *359 examples: - default: *356 + default: *360 x-github: enabledForGitHubApps: true category: orgs @@ -43259,19 +44208,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - *83 + - *355 + - *356 - *351 - *352 - - *347 - - *348 - - *354 + - *358 responses: '200': description: Response content: application/json: - schema: *355 + schema: *359 examples: - default: *356 + default: *360 x-github: enabledForGitHubApps: true category: orgs @@ -43289,13 +44238,13 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - *83 - - *353 - - *347 - - *348 + - *357 + - *351 + - *352 - *19 - *17 - *106 - - *357 + - *361 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -43376,7 +44325,7 @@ paths: application/json: schema: *22 examples: - default: &655 + default: &656 value: id: 1 account: @@ -43542,12 +44491,12 @@ paths: application/json: schema: anyOf: - - &359 + - &363 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &358 + limit: &362 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -43572,7 +44521,7 @@ paths: properties: {} additionalProperties: false examples: - default: &360 + default: &364 value: limit: collaborators_only origin: organization @@ -43601,13 +44550,13 @@ paths: required: true content: application/json: - schema: &656 + schema: &657 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *358 + limit: *362 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -43631,9 +44580,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 '422': *15 x-github: githubCloudOnly: false @@ -43711,9 +44660,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 '404': *6 @@ -43791,7 +44740,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *365 examples: default: value: @@ -43848,7 +44797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - *83 - - &363 + - &367 name: invitation_id description: The unique identifier of the invitation. in: path @@ -43882,7 +44831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - *83 - - *363 + - *367 - *17 - *19 responses: @@ -43892,9 +44841,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: &379 + default: &383 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -43937,7 +44886,7 @@ paths: application/json: schema: type: array - items: *364 + items: *368 examples: default: value: @@ -44022,9 +44971,9 @@ paths: description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: &365 + default: &369 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -44057,7 +45006,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - *83 - - &366 + - &370 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -44110,9 +45059,9 @@ paths: description: Response content: application/json: - schema: *364 + schema: *368 examples: - default: *365 + default: *369 '404': *6 '422': *7 x-github: @@ -44137,7 +45086,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - *83 - - *366 + - *370 responses: '204': description: Response @@ -44200,7 +45149,7 @@ paths: - closed - all default: open - - *367 + - *371 - name: type description: Can be the name of an issue type. in: query @@ -44219,7 +45168,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -44229,9 +45178,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *368 + default: *372 headers: Link: *43 '404': *6 @@ -44291,7 +45240,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '422': *15 @@ -44390,9 +45339,9 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: - default: *370 + default: *374 '304': *37 '500': *40 '401': *25 @@ -44419,7 +45368,7 @@ paths: parameters: - *83 - *138 - - &371 + - &375 name: codespace_name in: path required: true @@ -44454,15 +45403,15 @@ paths: parameters: - *83 - *138 - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: &574 + default: &575 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -44718,7 +45667,7 @@ paths: description: Response content: application/json: - schema: &372 + schema: &376 title: Org Membership description: Org Membership type: object @@ -44785,7 +45734,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &373 + response-if-user-has-an-active-admin-membership-with-organization: &377 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -44882,9 +45831,9 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: - response-if-user-already-had-membership-with-organization: *373 + response-if-user-already-had-membership-with-organization: *377 '422': *15 '403': *29 x-github: @@ -44955,7 +45904,7 @@ paths: application/json: schema: type: array - items: &374 + items: &378 title: Migration description: A migration. type: object @@ -45284,7 +46233,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -45463,7 +46412,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - *83 - - &375 + - &379 name: migration_id description: The unique identifier of the migration. in: path @@ -45490,7 +46439,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -45660,7 +46609,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - *83 - - *375 + - *379 responses: '302': description: Response @@ -45682,7 +46631,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - *83 - - *375 + - *379 responses: '204': description: Response @@ -45706,8 +46655,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - *83 - - *375 - - &829 + - *379 + - &831 name: repo_name description: repo_name parameter in: path @@ -45735,7 +46684,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - *83 - - *375 + - *379 - *17 - *19 responses: @@ -45745,9 +46694,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: &386 + default: &390 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -45956,7 +46905,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &376 + items: &380 title: Organization Role description: Organization roles type: object @@ -46163,7 +47112,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46215,7 +47164,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -46241,7 +47190,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - *83 - - *209 + - *210 - *137 responses: '204': @@ -46272,7 +47221,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - *83 - - *209 + - *210 - *137 responses: '204': @@ -46393,7 +47342,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46490,7 +47439,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *380 examples: default: value: @@ -46648,8 +47597,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 nullable: true type: description: The ownership type of the team @@ -46681,7 +47630,7 @@ paths: - type - parent examples: - default: *379 + default: *383 headers: Link: *43 '404': @@ -46739,13 +47688,13 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: &433 + items: &436 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 name: nullable: true type: string @@ -46840,7 +47789,7 @@ paths: - type - url examples: - default: *206 + default: *207 headers: Link: *43 '404': @@ -46891,7 +47840,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -47033,7 +47982,7 @@ paths: - nuget - container - *83 - - &830 + - &832 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -47069,12 +48018,12 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *381 + default: *385 '403': *29 '401': *25 - '400': &832 + '400': &834 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -47096,7 +48045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &382 + - &386 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 @@ -47114,7 +48063,7 @@ paths: - docker - nuget - container - - &383 + - &387 name: package_name description: The name of the package. in: path @@ -47127,7 +48076,7 @@ paths: description: Response content: application/json: - schema: *380 + schema: *384 examples: default: value: @@ -47179,8 +48128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 responses: '204': @@ -47213,8 +48162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - name: token description: package token @@ -47247,8 +48196,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: - - *382 - - *383 + - *386 + - *387 - *83 - *19 - *17 @@ -47269,7 +48218,7 @@ paths: application/json: schema: type: array - items: &384 + items: &388 title: Package Version description: A version of a software package type: object @@ -47394,10 +48343,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: - - *382 - - *383 + - *386 + - *387 - *83 - - &385 + - &389 name: package_version_id description: Unique identifier of the package version. in: path @@ -47409,7 +48358,7 @@ paths: description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -47445,10 +48394,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - - *385 + - *389 responses: '204': description: Response @@ -47480,10 +48429,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *382 - - *383 + - *386 + - *387 - *83 - - *385 + - *389 responses: '204': description: Response @@ -47513,7 +48462,7 @@ paths: - *83 - *17 - *19 - - &387 + - &391 name: sort description: The property by which to sort the results. in: query @@ -47524,7 +48473,7 @@ paths: - created_at default: created_at - *106 - - &388 + - &392 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -47535,7 +48484,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &389 + - &393 name: repository description: The name of the repository to use to filter the results. in: query @@ -47543,7 +48492,7 @@ paths: schema: type: string example: Hello-World - - &390 + - &394 name: permission description: The permission to use to filter the results. in: query @@ -47551,7 +48500,7 @@ paths: schema: type: string example: issues_read - - &391 + - &395 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) @@ -47561,7 +48510,7 @@ paths: schema: type: string format: date-time - - &392 + - &396 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) @@ -47571,7 +48520,7 @@ paths: schema: type: string format: date-time - - &393 + - &397 name: token_id description: The ID of the token in: query @@ -47882,9 +48831,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -47910,14 +48859,14 @@ paths: - *83 - *17 - *19 - - *387 - - *106 - - *388 - - *389 - - *390 - *391 + - *106 - *392 - *393 + - *394 + - *395 + - *396 + - *397 responses: '500': *40 '422': *15 @@ -48197,9 +49146,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -48241,7 +49190,7 @@ paths: type: integer configurations: type: array - items: &394 + items: &398 title: Organization private registry description: Private registry configuration for an organization type: object @@ -48531,7 +49480,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &395 + org-private-registry-with-selected-visibility: &399 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -48621,15 +49570,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *394 + schema: *398 examples: - default: *395 + default: *399 '404': *6 x-github: githubCloudOnly: false @@ -48651,7 +49600,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 requestBody: required: true content: @@ -48756,7 +49705,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - *83 - - *290 + - *294 responses: '204': description: Response @@ -48767,266 +49716,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: - - *83 - - 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: &396 - title: Project - description: Projects are a way to organize columns and cards of - work. - type: object - properties: - owner_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test - url: - type: string - format: uri - example: https://api.github.com/projects/1002604 - html_url: - type: string - format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: - type: string - format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: - type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week - in January - type: string - nullable: true - number: - type: integer - example: 1 - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - creator: - title: Simple User - description: A GitHub user. - type: object - properties: *20 - required: *21 - nullable: true - created_at: - type: string - format: date-time - example: '2011-04-10T20:09:31Z' - updated_at: - type: string - format: date-time - example: '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: *43 - '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: - - *83 - 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: *396 - 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': *25 - '403': *29 - '404': *6 - '410': &477 - 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 @@ -49056,7 +49745,7 @@ paths: application/json: schema: type: array - items: &397 + items: &400 title: Projects v2 Project description: A projects v2 project type: object @@ -49126,7 +49815,7 @@ paths: title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: &910 + properties: &912 id: type: number description: The unique identifier of the status update. @@ -49174,7 +49863,7 @@ paths: example: The project is off to a great start! type: string nullable: true - required: &911 + required: &913 - id - node_id - created_at @@ -49199,7 +49888,7 @@ paths: - deleted_at - deleted_by examples: - default: &398 + default: &401 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -49302,7 +49991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-organization parameters: - - &399 + - &402 name: project_number description: The project's number. in: path @@ -49315,9 +50004,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -49339,7 +50028,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-organization parameters: - - *399 + - *402 - *83 - *17 - *104 @@ -49351,7 +50040,7 @@ paths: application/json: schema: type: array - items: &400 + items: &403 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -49498,7 +50187,7 @@ paths: - updated_at - project_url examples: - default: &849 + default: &851 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49601,8 +50290,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-organization parameters: - - *399 - - &850 + - *402 + - &852 name: field_id description: The unique identifier of the field. in: path @@ -49615,9 +50304,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: &851 + default: &853 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -49661,7 +50350,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: - - *399 + - *402 - *83 - name: q description: Search query to filter items, see [Filtering projects](https://docs.github.com/enterprise-cloud@latest//issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) @@ -49694,7 +50383,7 @@ paths: application/json: schema: type: array - items: &406 + items: &409 title: Projects v2 Item description: An item belonging to a project type: object @@ -49710,7 +50399,7 @@ paths: format: uri example: https://api.github.com/users/monalisa/2/projectsV2/3 description: The API URL of the project that contains this item. - content_type: &404 + content_type: &407 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -49760,7 +50449,7 @@ paths: - updated_at - archived_at examples: - default: &407 + default: &410 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -50455,7 +51144,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-organization-owned-project parameters: - *83 - - *399 + - *402 requestBody: required: true description: Details of the item to add to the project. @@ -50492,7 +51181,7 @@ paths: description: Response content: application/json: - schema: &852 + schema: &854 title: Projects v2 Item description: An item belonging to a project type: object @@ -50505,8 +51194,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *226 - - &589 + - *227 + - &590 title: Pull Request Simple description: Pull Request Simple type: object @@ -50612,8 +51301,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true active_lock_reason: type: string @@ -50658,7 +51347,7 @@ paths: nullable: true requested_teams: type: array - items: *307 + items: *311 nullable: true head: type: object @@ -50709,7 +51398,7 @@ paths: _links: type: object properties: - comments: &403 + comments: &406 title: Link description: Hypermedia Link type: object @@ -50718,13 +51407,13 @@ paths: type: string required: - href - commits: *403 - statuses: *403 - html: *403 - issue: *403 - review_comments: *403 - review_comment: *403 - self: *403 + commits: *406 + statuses: *406 + html: *406 + issue: *406 + review_comments: *406 + review_comment: *406 + self: *406 required: - comments - commits @@ -50734,8 +51423,8 @@ paths: - review_comments - review_comment - self - author_association: *213 - auto_merge: &703 + author_association: *214 + auto_merge: &705 title: Auto merge description: The status of auto merging a pull request. type: object @@ -50837,7 +51526,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: *404 + content_type: *407 creator: *4 created_at: type: string @@ -50870,7 +51559,7 @@ paths: - updated_at - archived_at examples: - issue: &405 + issue: &408 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -50925,7 +51614,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: *405 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -50945,9 +51634,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: - - *399 + - *402 - *83 - - &408 + - &411 name: item_id description: The unique identifier of the project item. in: path @@ -50973,9 +51662,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -50996,9 +51685,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-organization parameters: - - *399 + - *402 - *83 - - *408 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -51068,13 +51757,13 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - text_field: *407 - number_field: *407 - date_field: *407 - single_select_field: *407 - iteration_field: *407 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -51094,9 +51783,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-organization parameters: - - *399 + - *402 - *83 - - *408 + - *411 responses: '204': description: Response @@ -51259,7 +51948,7 @@ paths: required: true content: application/json: - schema: *409 + schema: *412 examples: default: value: @@ -51484,7 +52173,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -51622,9 +52311,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -51827,7 +52516,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &480 title: Full Repository description: Full Repository type: object @@ -52104,8 +52793,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *410 - required: *411 + properties: *413 + required: *414 nullable: true temp_clone_token: type: string @@ -52192,8 +52881,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true organization: title: Simple User @@ -52220,7 +52909,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &594 + properties: &595 url: type: string format: uri @@ -52236,12 +52925,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &595 + required: &596 - url - key - name - html_url - security_and_analysis: *412 + security_and_analysis: *415 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -52325,7 +53014,7 @@ paths: - network_count - subscribers_count examples: - default: &481 + default: &482 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -52851,9 +53540,9 @@ paths: application/json: schema: type: array - items: *413 + items: *416 examples: - default: *414 + default: *417 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -52878,7 +53567,7 @@ paths: - *83 - *17 - *19 - - &726 + - &728 name: targets description: | A comma-separated list of rule targets to filter by. @@ -52969,11 +53658,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *164 - conditions: *415 + conditions: *418 rules: type: array description: An array of rules within the ruleset. - items: &417 + items: &420 title: Repository Rule type: object description: A repository rule. @@ -53037,7 +53726,7 @@ paths: application/json: schema: *185 examples: - default: &416 + default: &419 value: id: 21 name: super cool ruleset @@ -53092,7 +53781,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - *83 - - &728 + - &730 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 @@ -53102,16 +53791,16 @@ paths: schema: type: string x-multi-segment: true - - *304 + - *308 - *101 - - &729 + - &731 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 - - &730 + - &732 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -53131,7 +53820,7 @@ paths: description: Response content: application/json: - schema: &731 + schema: &733 title: Rule Suites description: Response type: array @@ -53186,7 +53875,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &732 + default: &734 value: - id: 21 actor_id: 12 @@ -53230,7 +53919,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - *83 - - &733 + - &735 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -53246,7 +53935,7 @@ paths: description: Response content: application/json: - schema: &734 + schema: &736 title: Rule Suite description: Response type: object @@ -53345,7 +54034,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &735 + default: &737 value: id: 21 actor_id: 12 @@ -53420,7 +54109,7 @@ paths: application/json: schema: *185 examples: - default: *416 + default: *419 '404': *6 '500': *40 put: @@ -53469,11 +54158,11 @@ paths: type: array description: The actors that can bypass the rules in this ruleset items: *164 - conditions: *415 + conditions: *418 rules: description: An array of rules within the ruleset. type: array - items: *417 + items: *420 examples: default: value: @@ -53510,7 +54199,7 @@ paths: application/json: schema: *185 examples: - default: *416 + default: *419 '404': *6 '500': *40 delete: @@ -53569,7 +54258,7 @@ paths: type: array items: *189 examples: - default: *418 + default: *421 '404': *6 '500': *40 x-github: @@ -53606,7 +54295,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *422 examples: default: value: @@ -53669,14 +54358,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - *83 - - *420 - - *421 - - *422 - *423 + - *424 + - *425 + - *426 - *106 - *19 - *17 - - &737 + - &739 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 @@ -53686,7 +54375,7 @@ paths: required: false schema: type: string - - &738 + - &740 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 @@ -53696,10 +54385,10 @@ paths: required: false schema: type: string - - *424 - - *425 - - *426 - *427 + - *428 + - *429 + - *430 responses: '200': description: Response @@ -53707,9 +54396,9 @@ paths: application/json: schema: type: array - items: *428 + items: *431 examples: - default: *429 + default: *432 headers: Link: *43 '404': *6 @@ -53744,9 +54433,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *433 examples: - default: *431 + default: *434 '403': *29 '404': *6 patch: @@ -53899,7 +54588,7 @@ paths: application/json: schema: type: array - items: &759 + items: &761 description: A repository security advisory. type: object properties: @@ -54119,7 +54808,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 credits_detailed: type: array nullable: true @@ -54129,7 +54818,7 @@ paths: type: object properties: user: *4 - type: *432 + type: *435 state: type: string description: The state of the user's acceptance of the @@ -54153,7 +54842,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *307 + items: *311 private_fork: readOnly: true nullable: true @@ -54190,7 +54879,7 @@ paths: - private_fork additionalProperties: false examples: - default: &760 + default: &762 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -54577,9 +55266,9 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: *379 + default: *383 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54603,7 +55292,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -54629,7 +55318,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -54664,9 +55353,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54691,7 +55380,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - *83 - - *436 + - *439 - *17 - *19 responses: @@ -54699,9 +55388,9 @@ paths: description: Success content: application/json: - schema: *437 + schema: *440 examples: - default: *438 + default: *441 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -54729,9 +55418,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *442 examples: - default: *440 + default: *443 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54759,9 +55448,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54905,9 +55594,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *294 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54976,7 +55665,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -54999,7 +55688,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - *83 - - *274 + - *278 responses: '204': description: Response @@ -55042,7 +55731,7 @@ paths: type: array items: *143 examples: - default: *443 + default: *446 headers: Link: *43 x-github: @@ -55243,15 +55932,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: - *83 - - *444 + - *447 responses: '200': description: Response content: application/json: - schema: *445 + schema: *448 examples: - default: *446 + default: *449 headers: Link: *43 x-github: @@ -55289,7 +55978,7 @@ paths: description: Response content: application/json: - schema: &468 + schema: &471 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -55335,7 +56024,7 @@ paths: type: string nullable: true examples: - default: &469 + default: &472 value: groups: - group_id: '123' @@ -55381,7 +56070,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - *83 - - *209 + - *210 - 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`). @@ -55413,13 +56102,13 @@ paths: application/json: schema: type: array - items: *201 + items: *202 examples: - default: *202 + default: *203 '500': *40 '403': *29 '404': *6 - '422': *203 + '422': *204 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55447,9 +56136,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 headers: Link: *43 '403': *29 @@ -55543,7 +56232,7 @@ paths: description: Response content: application/json: - schema: &447 + schema: &450 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -55606,8 +56295,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *377 - required: *378 + properties: *381 + required: *382 nullable: true members_count: type: integer @@ -55870,7 +56559,7 @@ paths: - repos_count - organization examples: - default: &448 + default: &451 value: id: 1 node_id: MDQ6VGVhbTE= @@ -55941,15 +56630,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 x-github: githubCloudOnly: false @@ -55971,7 +56660,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - *83 - - *209 + - *210 requestBody: required: false content: @@ -56033,16 +56722,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '201': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 '422': *15 '403': *29 @@ -56068,7 +56757,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - *83 - - *209 + - *210 responses: '204': description: Response @@ -56095,7 +56784,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - *83 - - *209 + - *210 - *106 - *17 - *19 @@ -56112,7 +56801,7 @@ paths: application/json: schema: type: array - items: &449 + items: &452 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -56191,7 +56880,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *214 + reactions: *215 required: - author - body @@ -56211,7 +56900,7 @@ paths: - updated_at - url examples: - default: &803 + default: &805 value: - author: login: octocat @@ -56286,7 +56975,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - *83 - - *209 + - *210 requestBody: required: true content: @@ -56320,9 +57009,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &450 + default: &453 value: author: login: octocat @@ -56395,8 +57084,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - *83 - - *209 - - &451 + - *210 + - &454 name: discussion_number description: The number that identifies the discussion. in: path @@ -56408,9 +57097,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56433,8 +57122,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: false content: @@ -56457,9 +57146,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &804 + default: &806 value: author: login: octocat @@ -56530,8 +57219,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 responses: '204': description: Response @@ -56558,8 +57247,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - *83 - - *209 - - *451 + - *210 + - *454 - *106 - *17 - *19 @@ -56570,7 +57259,7 @@ paths: application/json: schema: type: array - items: &452 + items: &455 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -56627,7 +57316,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *214 + reactions: *215 required: - author - body @@ -56642,7 +57331,7 @@ paths: - updated_at - url examples: - default: &805 + default: &807 value: - author: login: octocat @@ -56711,8 +57400,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: true content: @@ -56734,9 +57423,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: &453 + default: &456 value: author: login: octocat @@ -56803,9 +57492,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - *83 - - *209 - - *451 - - &454 + - *210 + - *454 + - &457 name: comment_number description: The number that identifies the comment. in: path @@ -56817,9 +57506,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56842,9 +57531,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 requestBody: required: true content: @@ -56866,9 +57555,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: &806 + default: &808 value: author: login: octocat @@ -56933,9 +57622,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 responses: '204': description: Response @@ -56962,9 +57651,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 - 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. @@ -56990,7 +57679,7 @@ paths: application/json: schema: type: array - items: &455 + items: &458 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -57033,7 +57722,7 @@ paths: - content - created_at examples: - default: &457 + default: &460 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57084,9 +57773,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - *83 - - *209 - - *451 + - *210 - *454 + - *457 requestBody: required: true content: @@ -57119,9 +57808,9 @@ paths: team discussion comment content: application/json: - schema: *455 + schema: *458 examples: - default: &456 + default: &459 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -57150,9 +57839,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57176,10 +57865,10 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - *83 - - *209 - - *451 + - *210 - *454 - - &458 + - *457 + - &461 name: reaction_id description: The unique identifier of the reaction. in: path @@ -57212,8 +57901,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 - 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. @@ -57239,9 +57928,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -57268,8 +57957,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - *83 - - *209 - - *451 + - *210 + - *454 requestBody: required: true content: @@ -57301,16 +57990,16 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -57334,9 +58023,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - *83 - - *209 - - *451 - - *458 + - *210 + - *454 + - *461 responses: '204': description: Response @@ -57360,15 +58049,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: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *459 + schema: *462 examples: - default: *460 + default: *463 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -57388,7 +58077,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: - *83 - - *209 + - *210 requestBody: required: true content: @@ -57411,9 +58100,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -57433,7 +58122,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: - *83 - - *209 + - *210 responses: '204': description: Response @@ -57458,7 +58147,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -57468,9 +58157,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 x-github: @@ -57493,7 +58182,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - *83 - - *209 + - *210 - name: role description: Filters members returned by their role in the team. in: query @@ -57516,7 +58205,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -57547,14 +58236,14 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 responses: '200': description: Response content: application/json: - schema: &463 + schema: &466 title: Team Membership description: Team Membership type: object @@ -57581,7 +58270,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &807 + response-if-user-is-a-team-maintainer: &809 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -57618,7 +58307,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 requestBody: required: false @@ -57644,9 +58333,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-users-membership-with-team-is-now-pending: &808 + response-if-users-membership-with-team-is-now-pending: &810 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -57682,7 +58371,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - *83 - - *209 + - *210 - *138 responses: '204': @@ -57709,7 +58398,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -57719,7 +58408,7 @@ paths: application/json: schema: type: array - items: &464 + items: &467 title: Team Project description: A team's access to a project. type: object @@ -57787,7 +58476,7 @@ paths: - updated_at - permissions examples: - default: &809 + default: &811 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57851,8 +58540,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - *83 - - *209 - - &465 + - *210 + - &468 name: project_id description: The unique identifier of the project. in: path @@ -57864,9 +58553,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: &810 + default: &812 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -57929,8 +58618,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - *83 - - *209 - - *465 + - *210 + - *468 requestBody: required: false content: @@ -57997,8 +58686,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - *83 - - *209 - - *465 + - *210 + - *468 responses: '204': description: Response @@ -58026,7 +58715,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -58036,9 +58725,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -58068,15 +58757,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &811 + schema: &813 title: Team Repository description: A team's access to a repository. type: object @@ -58099,8 +58788,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true forks: type: integer @@ -58646,9 +59335,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 requestBody: required: false content: @@ -58694,9 +59383,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - *83 - - *209 - - *466 - - *467 + - *210 + - *469 + - *470 responses: '204': description: Response @@ -58723,15 +59412,15 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - *83 - - *209 + - *210 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -58754,7 +59443,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - *83 - - *209 + - *210 requestBody: required: true content: @@ -58797,7 +59486,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -58830,7 +59519,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - *83 - - *209 + - *210 - *17 - *19 responses: @@ -58840,9 +59529,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - response-if-child-teams-exist: &812 + response-if-child-teams-exist: &814 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -58969,7 +59658,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#get-a-project-card parameters: - - &470 + - &473 name: card_id description: The unique identifier of the card. in: path @@ -58981,7 +59670,7 @@ paths: description: Response content: application/json: - schema: &471 + schema: &474 title: Project Card description: Project cards represent a scope of work. type: object @@ -59048,7 +59737,7 @@ paths: - created_at - updated_at examples: - default: &472 + default: &475 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -59104,7 +59793,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#update-an-existing-project-card parameters: - - *470 + - *473 requestBody: required: false content: @@ -59131,9 +59820,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *474 examples: - default: *472 + default: *475 '304': *37 '403': *29 '401': *25 @@ -59160,7 +59849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#delete-a-project-card parameters: - - *470 + - *473 responses: '204': description: Response @@ -59204,7 +59893,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#move-a-project-card parameters: - - *470 + - *473 requestBody: required: true content: @@ -59315,7 +60004,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#get-a-project-column parameters: - - &473 + - &476 name: column_id description: The unique identifier of the column. in: path @@ -59327,7 +60016,7 @@ paths: description: Response content: application/json: - schema: &474 + schema: &477 title: Project Column description: Project columns contain cards of work. type: object @@ -59373,7 +60062,7 @@ paths: - created_at - updated_at examples: - default: &475 + default: &478 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -59408,7 +60097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#update-an-existing-project-column parameters: - - *473 + - *476 requestBody: required: true content: @@ -59432,9 +60121,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 '304': *37 '403': *29 '401': *25 @@ -59459,7 +60148,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#delete-a-project-column parameters: - - *473 + - *476 responses: '204': description: Response @@ -59488,7 +60177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#list-project-cards parameters: - - *473 + - *476 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -59509,7 +60198,7 @@ paths: application/json: schema: type: array - items: *471 + items: *474 examples: default: value: @@ -59568,7 +60257,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/cards#create-a-project-card parameters: - - *473 + - *476 requestBody: required: true content: @@ -59608,9 +60297,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *474 examples: - default: *472 + default: *475 '304': *37 '403': *29 '401': *25 @@ -59620,8 +60309,8 @@ paths: application/json: schema: oneOf: - - *255 - - *256 + - *259 + - *260 '503': description: Response content: @@ -59666,7 +60355,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/columns#move-a-project-column parameters: - - *473 + - *476 requestBody: required: true content: @@ -59712,208 +60401,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: - - *465 - responses: - '200': - description: Response - content: - application/json: - schema: *396 - examples: - default: &476 - 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': *37 - '403': *29 - '401': *25 - 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: - - *465 - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - 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: *396 - examples: - default: *476 - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *477 - '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: - - *465 - responses: - '204': - description: Delete Success - '304': *37 - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': *25 - '410': *477 - '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 @@ -59928,7 +60415,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#list-project-collaborators parameters: - - *465 + - *468 - 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 @@ -59955,7 +60442,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -59985,7 +60472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#add-project-collaborator parameters: - - *465 + - *468 - *138 requestBody: required: false @@ -60038,7 +60525,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects-classic/collaborators#remove-user-as-a-collaborator parameters: - - *465 + - *468 - *138 responses: '204': @@ -60070,7 +60557,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: - - *465 + - *468 - *138 responses: '200': @@ -60171,7 +60658,7 @@ paths: resources: type: object properties: - core: &478 + core: &479 title: Rate Limit type: object properties: @@ -60188,21 +60675,21 @@ paths: - remaining - reset - used - graphql: *478 - search: *478 - code_search: *478 - source_import: *478 - integration_manifest: *478 - code_scanning_upload: *478 - actions_runner_registration: *478 - scim: *478 - dependency_snapshots: *478 - dependency_sbom: *478 - code_scanning_autofix: *478 + graphql: *479 + search: *479 + code_search: *479 + source_import: *479 + integration_manifest: *479 + code_scanning_upload: *479 + actions_runner_registration: *479 + scim: *479 + dependency_snapshots: *479 + dependency_sbom: *479 + code_scanning_autofix: *479 required: - core - search - rate: *478 + rate: *479 required: - rate - resources @@ -60307,14 +60794,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *479 + schema: *480 examples: default-response: summary: Default response @@ -60819,7 +61306,7 @@ paths: status: disabled '403': *29 '404': *6 - '301': *480 + '301': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60837,8 +61324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -61095,10 +61582,10 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 - '307': &482 + default: *482 + '307': &483 description: Temporary Redirect content: application/json: @@ -61127,8 +61614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -61150,7 +61637,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': *482 + '307': *483 '404': *6 '409': *114 x-github: @@ -61174,11 +61661,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - - &497 + - &498 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -61201,7 +61688,7 @@ paths: type: integer artifacts: type: array - items: &483 + items: &484 title: Artifact description: An artifact type: object @@ -61279,7 +61766,7 @@ paths: - expires_at - updated_at examples: - default: &498 + default: &499 value: total_count: 2 artifacts: @@ -61340,9 +61827,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *466 - - *467 - - &484 + - *469 + - *470 + - &485 name: artifact_id description: The unique identifier of the artifact. in: path @@ -61354,7 +61841,7 @@ paths: description: Response content: application/json: - schema: *483 + schema: *484 examples: default: value: @@ -61392,9 +61879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *466 - - *467 - - *484 + - *469 + - *470 + - *485 responses: '204': description: Response @@ -61418,9 +61905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *466 - - *467 - - *484 + - *469 + - *470 + - *485 - name: archive_format in: path required: true @@ -61434,7 +61921,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': *477 + '410': &660 + description: Gone + content: + application/json: + schema: *3 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61457,14 +61948,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *485 + schema: *486 examples: default: value: @@ -61490,11 +61981,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: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - - &486 + - &487 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 @@ -61528,7 +62019,7 @@ paths: description: Response content: application/json: - schema: &487 + schema: &488 title: Repository actions caches description: Repository actions caches type: object @@ -61570,7 +62061,7 @@ paths: - total_count - actions_caches examples: - default: &488 + default: &489 value: total_count: 1 actions_caches: @@ -61602,23 +62093,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: - - *466 - - *467 + - *469 + - *470 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *486 + - *487 responses: '200': description: Response content: application/json: - schema: *487 + schema: *488 examples: - default: *488 + default: *489 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61638,8 +62129,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: - - *466 - - *467 + - *469 + - *470 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -61670,9 +62161,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: - - *466 - - *467 - - &489 + - *469 + - *470 + - &490 name: job_id description: The unique identifier of the job. in: path @@ -61684,7 +62175,7 @@ paths: description: Response content: application/json: - schema: &501 + schema: &502 title: Job description: Information of a job execution in a workflow run type: object @@ -61991,9 +62482,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: - - *466 - - *467 - - *489 + - *469 + - *470 + - *490 responses: '302': description: Response @@ -62021,9 +62512,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: - - *466 - - *467 - - *489 + - *469 + - *470 + - *490 requestBody: required: false content: @@ -62044,7 +62535,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -62068,8 +62559,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Status response @@ -62119,8 +62610,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -62154,7 +62645,7 @@ paths: description: Empty response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -62183,8 +62674,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -62202,7 +62693,7 @@ paths: type: integer secrets: type: array - items: &503 + items: &504 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -62222,7 +62713,7 @@ paths: - created_at - updated_at examples: - default: &504 + default: &505 value: total_count: 2 secrets: @@ -62255,9 +62746,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *466 - - *467 - - *490 + - *469 + - *470 + - *491 - *19 responses: '200': @@ -62274,7 +62765,7 @@ paths: type: integer variables: type: array - items: &507 + items: &508 title: Actions Variable type: object properties: @@ -62304,7 +62795,7 @@ paths: - created_at - updated_at examples: - default: &508 + default: &509 value: total_count: 2 variables: @@ -62337,8 +62828,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62347,11 +62838,11 @@ paths: schema: type: object properties: - enabled: &491 + enabled: &492 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *56 - selected_actions_url: *267 + selected_actions_url: *271 sha_pinning_required: *57 required: - enabled @@ -62382,8 +62873,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62394,7 +62885,7 @@ paths: schema: type: object properties: - enabled: *491 + enabled: *492 allowed_actions: *56 sha_pinning_required: *57 required: @@ -62427,14 +62918,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &492 + schema: &493 type: object properties: access_level: @@ -62452,7 +62943,7 @@ paths: required: - access_level examples: - default: &493 + default: &494 value: access_level: organization x-github: @@ -62477,15 +62968,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *492 + schema: *493 examples: - default: *493 + default: *494 responses: '204': description: Response @@ -62509,14 +63000,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *269 + schema: *273 examples: default: value: @@ -62540,8 +63031,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Empty response for successful settings update @@ -62551,7 +63042,7 @@ paths: required: true content: application/json: - schema: *270 + schema: *274 examples: default: summary: Set retention days @@ -62575,8 +63066,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62584,7 +63075,7 @@ paths: application/json: schema: *58 examples: - default: *271 + default: *275 '404': *6 x-github: enabledForGitHubApps: true @@ -62603,8 +63094,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62638,14 +63129,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *272 + schema: *276 examples: default: *59 '403': *29 @@ -62667,13 +63158,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *273 + schema: *277 examples: default: *59 responses: @@ -62699,8 +63190,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62731,8 +63222,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -62764,14 +63255,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *276 + schema: *280 examples: default: *65 x-github: @@ -62794,8 +63285,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Success response @@ -62806,7 +63297,7 @@ paths: required: true content: application/json: - schema: *277 + schema: *281 examples: default: *65 x-github: @@ -62835,8 +63326,8 @@ paths: in: query schema: type: string - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -62880,8 +63371,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -62889,9 +63380,9 @@ paths: application/json: schema: type: array - items: *281 + items: *285 examples: - default: *282 + default: *286 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62913,8 +63404,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -62957,7 +63448,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *283 + '201': *287 '404': *6 '422': *7 '409': *114 @@ -62988,8 +63479,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: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -62997,7 +63488,7 @@ paths: application/json: schema: *75 examples: - default: *284 + default: *288 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63025,8 +63516,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: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -63034,7 +63525,7 @@ paths: application/json: schema: *75 examples: - default: *285 + default: *289 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63056,8 +63547,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '200': @@ -63066,7 +63557,7 @@ paths: application/json: schema: *72 examples: - default: *286 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63087,8 +63578,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '204': @@ -63115,8 +63606,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: '200': *77 @@ -63141,8 +63632,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: - - *466 - - *467 + - *469 + - *470 - *71 requestBody: required: true @@ -63191,8 +63682,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: - - *466 - - *467 + - *469 + - *470 - *71 requestBody: required: true @@ -63242,11 +63733,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: - - *466 - - *467 + - *469 + - *470 - *71 responses: - '200': *287 + '200': *291 '404': *6 x-github: githubCloudOnly: false @@ -63273,10 +63764,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: - - *466 - - *467 + - *469 + - *470 - *71 - - *288 + - *292 responses: '200': *77 '404': *6 @@ -63304,9 +63795,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: - - *466 - - *467 - - &511 + - *469 + - *470 + - &512 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. @@ -63314,7 +63805,7 @@ paths: required: false schema: type: string - - &512 + - &513 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -63322,7 +63813,7 @@ paths: required: false schema: type: string - - &513 + - &514 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -63331,7 +63822,7 @@ paths: required: false schema: type: string - - &514 + - &515 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 @@ -63358,7 +63849,7 @@ paths: - pending - *17 - *19 - - &515 + - &516 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)." @@ -63367,7 +63858,7 @@ paths: schema: type: string format: date-time - - &494 + - &495 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -63376,13 +63867,13 @@ paths: schema: type: boolean default: false - - &516 + - &517 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &517 + - &518 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -63405,7 +63896,7 @@ paths: type: integer workflow_runs: type: array - items: &495 + items: &496 title: Workflow Run description: An invocation of a workflow type: object @@ -63500,7 +63991,7 @@ paths: that triggered the run. type: array nullable: true - items: &536 + items: &537 title: Pull Request Minimal type: object properties: @@ -63619,7 +64110,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &540 + properties: &541 id: type: string description: SHA for the commit @@ -63670,7 +64161,7 @@ paths: - name - email nullable: true - required: &541 + required: &542 - id - tree_id - message @@ -63678,8 +64169,8 @@ paths: - author - committer nullable: true - repository: *280 - head_repository: *280 + repository: *284 + head_repository: *284 head_repository_id: type: integer example: 5 @@ -63717,7 +64208,7 @@ paths: - workflow_url - pull_requests examples: - default: &518 + default: &519 value: total_count: 1 workflow_runs: @@ -63953,24 +64444,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *466 - - *467 - - &496 + - *469 + - *470 + - &497 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *494 + - *495 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: &499 + default: &500 value: id: 30433642 name: Build @@ -64211,9 +64702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '204': description: Response @@ -64236,9 +64727,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -64357,15 +64848,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64392,12 +64883,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 - *17 - *19 - - *497 + - *498 responses: '200': description: Response @@ -64413,9 +64904,9 @@ paths: type: integer artifacts: type: array - items: *483 + items: *484 examples: - default: *498 + default: *499 headers: Link: *43 x-github: @@ -64439,25 +64930,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *466 - - *467 - - *496 - - &500 + - *469 + - *470 + - *497 + - &501 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *494 + - *495 responses: '200': description: Response content: application/json: - schema: *495 + schema: *496 examples: - default: *499 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64480,10 +64971,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: - - *466 - - *467 - - *496 - - *500 + - *469 + - *470 + - *497 + - *501 - *17 - *19 responses: @@ -64501,9 +64992,9 @@ paths: type: integer jobs: type: array - items: *501 + items: *502 examples: - default: &502 + default: &503 value: total_count: 1 jobs: @@ -64616,10 +65107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *466 - - *467 - - *496 - - *500 + - *469 + - *470 + - *497 + - *501 responses: '302': description: Response @@ -64647,15 +65138,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '202': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64682,9 +65173,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: true content: @@ -64751,15 +65242,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '202': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -64786,9 +65277,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 - 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 @@ -64818,9 +65309,9 @@ paths: type: integer jobs: type: array - items: *501 + items: *502 examples: - default: *502 + default: *503 headers: Link: *43 x-github: @@ -64845,9 +65336,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '302': description: Response @@ -64874,9 +65365,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '204': description: Response @@ -64903,9 +65394,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -64965,7 +65456,7 @@ paths: items: type: object properties: - type: &625 + type: &626 type: string description: The type of reviewer. enum: @@ -64975,7 +65466,7 @@ paths: reviewer: anyOf: - *4 - - *307 + - *311 required: - environment - wait_timer @@ -65050,9 +65541,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: true content: @@ -65099,7 +65590,7 @@ paths: application/json: schema: type: array - items: &611 + items: &612 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -65187,8 +65678,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -65205,7 +65696,7 @@ paths: - created_at - updated_at examples: - default: &612 + default: &613 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -65261,9 +65752,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: false content: @@ -65284,7 +65775,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65307,9 +65798,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: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 requestBody: required: false content: @@ -65330,7 +65821,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65363,9 +65854,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *466 - - *467 - - *496 + - *469 + - *470 + - *497 responses: '200': description: Response @@ -65502,8 +65993,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -65521,9 +66012,9 @@ paths: type: integer secrets: type: array - items: *503 + items: *504 examples: - default: *504 + default: *505 headers: Link: *43 x-github: @@ -65548,16 +66039,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *505 + schema: *506 examples: - default: *506 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65579,17 +66070,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: &638 + default: &639 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -65615,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -65648,7 +66139,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65674,9 +66165,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -65701,9 +66192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *466 - - *467 - - *490 + - *469 + - *470 + - *491 - *19 responses: '200': @@ -65720,9 +66211,9 @@ paths: type: integer variables: type: array - items: *507 + items: *508 examples: - default: *508 + default: *509 headers: Link: *43 x-github: @@ -65745,8 +66236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -65773,7 +66264,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -65798,17 +66289,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: &639 + default: &640 value: name: USERNAME value: octocat @@ -65834,9 +66325,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 requestBody: required: true content: @@ -65878,9 +66369,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *466 - - *467 - - *293 + - *469 + - *470 + - *297 responses: '204': description: Response @@ -65905,8 +66396,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -65924,7 +66415,7 @@ paths: type: integer workflows: type: array - items: &509 + items: &510 title: Workflow description: A GitHub Actions workflow type: object @@ -66031,9 +66522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *466 - - *467 - - &510 + - *469 + - *470 + - &511 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -66048,7 +66539,7 @@ paths: description: Response content: application/json: - schema: *509 + schema: *510 examples: default: value: @@ -66081,9 +66572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66108,9 +66599,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66161,9 +66652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '204': description: Response @@ -66190,19 +66681,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: - - *466 - - *467 - - *510 + - *469 + - *470 - *511 - *512 - *513 - *514 + - *515 - *17 - *19 - - *515 - - *494 - *516 + - *495 - *517 + - *518 responses: '200': description: Response @@ -66218,9 +66709,9 @@ paths: type: integer workflow_runs: type: array - items: *495 + items: *496 examples: - default: *518 + default: *519 headers: Link: *43 x-github: @@ -66253,9 +66744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *466 - - *467 - - *510 + - *469 + - *470 + - *511 responses: '200': description: Response @@ -66316,8 +66807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *466 - - *467 + - *469 + - *470 - *106 - *17 - *104 @@ -66481,8 +66972,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -66494,7 +66985,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -66519,8 +67010,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: - - *466 - - *467 + - *469 + - *470 - name: assignee in: path required: true @@ -66556,8 +67047,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -66669,8 +67160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *104 - *105 @@ -66727,7 +67218,7 @@ paths: initiator: type: string examples: - default: *519 + default: *520 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66747,8 +67238,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -66756,7 +67247,7 @@ paths: application/json: schema: type: array - items: &520 + items: &521 title: Autolink reference description: An autolink reference. type: object @@ -66810,8 +67301,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -66850,9 +67341,9 @@ paths: description: response content: application/json: - schema: *520 + schema: *521 examples: - default: &521 + default: &522 value: id: 1 key_prefix: TICKET- @@ -66883,9 +67374,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: - - *466 - - *467 - - &522 + - *469 + - *470 + - &523 name: autolink_id description: The unique identifier of the autolink. in: path @@ -66897,9 +67388,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *521 examples: - default: *521 + default: *522 '404': *6 x-github: githubCloudOnly: false @@ -66919,9 +67410,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: - - *466 - - *467 - - *522 + - *469 + - *470 + - *523 responses: '204': description: Response @@ -66945,8 +67436,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response if Dependabot is enabled @@ -66994,8 +67485,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-dependabot-security-updates parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -67016,8 +67507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-dependabot-security-updates parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -67037,8 +67528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *466 - - *467 + - *469 + - *470 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -67076,7 +67567,7 @@ paths: - url protected: type: boolean - protection: &524 + protection: &525 title: Branch Protection description: Branch Protection type: object @@ -67118,7 +67609,7 @@ paths: required: - contexts - checks - enforce_admins: &527 + enforce_admins: &528 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -67133,7 +67624,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &529 + required_pull_request_reviews: &530 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -67154,7 +67645,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *307 + items: *311 apps: description: The list of apps with review dismissal access. @@ -67183,7 +67674,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *307 + items: *311 apps: description: The list of apps allowed to bypass pull request requirements. @@ -67209,7 +67700,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &526 + restrictions: &527 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -67272,7 +67763,7 @@ paths: type: string teams: type: array - items: *307 + items: *311 apps: type: array items: @@ -67486,9 +67977,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *466 - - *467 - - &525 + - *469 + - *470 + - &526 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). @@ -67502,14 +67993,14 @@ paths: description: Response content: application/json: - schema: &535 + schema: &536 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &585 + commit: &586 title: Commit description: Commit type: object @@ -67543,7 +68034,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &523 + properties: &524 name: type: string example: '"Chris Wanstrath"' @@ -67558,7 +68049,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true message: type: string @@ -67579,7 +68070,7 @@ paths: required: - sha - url - verification: &645 + verification: &646 title: Verification type: object properties: @@ -67613,12 +68104,12 @@ paths: nullable: true oneOf: - *4 - - *291 + - *295 committer: nullable: true oneOf: - *4 - - *291 + - *295 parents: type: array items: @@ -67649,7 +68140,7 @@ paths: type: integer files: type: array - items: &598 + items: &599 title: Diff Entry description: Diff Entry type: object @@ -67733,7 +68224,7 @@ paths: - self protected: type: boolean - protection: *524 + protection: *525 protection_url: type: string format: uri @@ -67840,7 +68331,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *480 + '301': *481 '404': *6 x-github: githubCloudOnly: false @@ -67862,15 +68353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *524 + schema: *525 examples: default: value: @@ -68064,9 +68555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -68321,7 +68812,7 @@ paths: url: type: string format: uri - required_status_checks: &532 + required_status_checks: &533 title: Status Check Policy description: Status Check Policy type: object @@ -68397,7 +68888,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 apps: type: array items: *5 @@ -68415,7 +68906,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 apps: type: array items: *5 @@ -68473,7 +68964,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *526 + restrictions: *527 required_conversation_resolution: type: object properties: @@ -68585,9 +69076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68612,17 +69103,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: &528 + default: &529 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -68644,17 +69135,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: *528 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68673,9 +69164,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68700,17 +69191,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: &530 + default: &531 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -68806,9 +69297,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -68906,9 +69397,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *530 examples: - default: *530 + default: *531 '422': *15 x-github: githubCloudOnly: false @@ -68929,9 +69420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -68958,17 +69449,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: &531 + default: &532 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -68991,17 +69482,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *527 + schema: *528 examples: - default: *531 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -69021,9 +69512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69048,17 +69539,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: &533 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -69084,9 +69575,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69138,9 +69629,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *533 examples: - default: *533 + default: *534 '404': *6 '422': *15 x-github: @@ -69162,9 +69653,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69188,9 +69679,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69224,9 +69715,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69293,9 +69784,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69359,9 +69850,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: content: application/json: @@ -69427,15 +69918,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response content: application/json: - schema: *526 + schema: *527 examples: default: value: @@ -69526,9 +70017,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '204': description: Response @@ -69551,9 +70042,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69563,7 +70054,7 @@ paths: type: array items: *5 examples: - default: &534 + default: &535 value: - id: 1 slug: octoapp @@ -69620,9 +70111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69656,7 +70147,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69677,9 +70168,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69713,7 +70204,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69734,9 +70225,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -69770,7 +70261,7 @@ paths: type: array items: *5 examples: - default: *534 + default: *535 '422': *15 x-github: githubCloudOnly: false @@ -69792,9 +70283,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -69802,9 +70293,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '404': *6 x-github: githubCloudOnly: false @@ -69824,9 +70315,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69862,9 +70353,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -69885,9 +70376,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: false content: @@ -69923,9 +70414,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -69946,9 +70437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: content: application/json: @@ -69983,9 +70474,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -70007,9 +70498,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: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 responses: '200': description: Response @@ -70019,7 +70510,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '404': *6 x-github: githubCloudOnly: false @@ -70043,9 +70534,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70078,7 +70569,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70103,9 +70594,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70138,7 +70629,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70163,9 +70654,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70198,7 +70689,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '422': *15 x-github: githubCloudOnly: false @@ -70225,9 +70716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 requestBody: required: true content: @@ -70249,7 +70740,7 @@ paths: description: Response content: application/json: - schema: *535 + schema: *536 examples: default: value: @@ -70363,8 +70854,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 @@ -70378,9 +70869,9 @@ paths: application/json: schema: type: array - items: *302 + items: *306 examples: - default: *303 + default: *307 '404': *6 '500': *40 "/repos/{owner}/{repo}/bypass-requests/push-rules/{bypass_request_number}": @@ -70400,8 +70891,8 @@ paths: category: repos subcategory: bypass-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70415,7 +70906,7 @@ paths: description: Response content: application/json: - schema: *302 + schema: *306 examples: default: value: @@ -70474,8 +70965,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 @@ -70489,9 +70980,9 @@ paths: application/json: schema: type: array - items: *305 + items: *309 examples: - default: *306 + default: *310 '404': *6 '403': *29 '500': *40 @@ -70515,8 +71006,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70528,7 +71019,7 @@ paths: description: A single bypass request. content: application/json: - schema: *305 + schema: *309 examples: default: value: @@ -70586,8 +71077,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_request_number in: path required: true @@ -70658,8 +71149,8 @@ paths: category: secret-scanning subcategory: delegated-bypass parameters: - - *466 - - *467 + - *469 + - *470 - name: bypass_response_id in: path required: true @@ -70692,8 +71183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -70972,7 +71463,7 @@ paths: description: Response content: application/json: - schema: &537 + schema: &538 title: CheckRun description: A check performed on the code of a given code change type: object @@ -71083,16 +71574,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *536 - deployment: &868 + items: *537 + deployment: &870 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -71159,8 +71650,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -71372,9 +71863,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *466 - - *467 - - &538 + - *469 + - *470 + - &539 name: check_run_id description: The unique identifier of the check run. in: path @@ -71386,9 +71877,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *538 examples: - default: &539 + default: &540 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -71488,9 +71979,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 requestBody: required: true content: @@ -71730,9 +72221,9 @@ paths: description: Response content: application/json: - schema: *537 + schema: *538 examples: - default: *539 + default: *540 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71752,9 +72243,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 - *17 - *19 responses: @@ -71849,15 +72340,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *466 - - *467 - - *538 + - *469 + - *470 + - *539 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -71895,8 +72386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -71918,7 +72409,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &542 + schema: &543 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -71982,7 +72473,7 @@ paths: nullable: true pull_requests: type: array - items: *536 + items: *537 nullable: true app: title: GitHub app @@ -71993,9 +72484,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - repository: *280 + properties: *212 + required: *213 + repository: *284 created_at: type: string format: date-time @@ -72004,12 +72495,12 @@ paths: type: string format: date-time nullable: true - head_commit: &894 + head_commit: &896 title: Simple Commit description: A commit. type: object - properties: *540 - required: *541 + properties: *541 + required: *542 latest_check_runs_count: type: integer check_runs_url: @@ -72037,7 +72528,7 @@ paths: - check_runs_url - pull_requests examples: - default: &543 + default: &544 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -72328,9 +72819,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *542 + schema: *543 examples: - default: *543 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72349,8 +72840,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -72411,7 +72902,7 @@ paths: required: - app_id - setting - repository: *280 + repository: *284 examples: default: value: @@ -72659,9 +73150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *466 - - *467 - - &544 + - *469 + - *470 + - &545 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -72673,9 +73164,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *543 examples: - default: *543 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72698,17 +73189,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: - - *466 - - *467 - - *544 - - &591 + - *469 + - *470 + - *545 + - &592 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &592 + - &593 name: status description: Returns check runs with the specified `status`. in: query @@ -72747,9 +73238,9 @@ paths: type: integer check_runs: type: array - items: *537 + items: *538 examples: - default: &593 + default: &594 value: total_count: 1 check_runs: @@ -72851,15 +73342,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *466 - - *467 - - *544 + - *469 + - *470 + - *545 responses: '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -72886,21 +73377,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: - - *466 - - *467 - - *311 - - *312 + - *469 + - *470 + - *315 + - *316 - *19 - *17 - - &560 + - &561 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: *545 - - &561 + schema: *546 + - &562 name: pr description: The number of the pull request for the results you want to list. in: query @@ -72925,13 +73416,13 @@ paths: be returned. in: query required: false - schema: *313 + schema: *317 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *546 + schema: *547 responses: '200': description: Response @@ -72947,7 +73438,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *547 + instances_url: *548 state: *109 fixed_at: *133 dismissed_by: @@ -72958,11 +73449,11 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *548 - dismissed_comment: *549 - rule: *550 - tool: *551 - most_recent_instance: *552 + dismissed_reason: *549 + dismissed_comment: *550 + rule: *551 + tool: *552 + most_recent_instance: *553 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73088,7 +73579,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &553 + '403': &554 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -73115,9 +73606,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: - - *466 - - *467 - - &554 + - *469 + - *470 + - &555 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -73131,7 +73622,7 @@ paths: description: Response content: application/json: - schema: &555 + schema: &556 type: object properties: number: *123 @@ -73139,7 +73630,7 @@ paths: updated_at: *131 url: *128 html_url: *129 - instances_url: *547 + instances_url: *548 state: *109 fixed_at: *133 dismissed_by: @@ -73150,8 +73641,8 @@ paths: required: *21 nullable: true dismissed_at: *132 - dismissed_reason: *548 - dismissed_comment: *549 + dismissed_reason: *549 + dismissed_comment: *550 rule: type: object properties: @@ -73205,8 +73696,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *551 - most_recent_instance: *552 + tool: *552 + most_recent_instance: *553 dismissal_approved_by: title: Simple User description: A GitHub user. @@ -73305,7 +73796,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73325,9 +73816,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: true content: @@ -73342,8 +73833,8 @@ paths: enum: - open - dismissed - dismissed_reason: *548 - dismissed_comment: *549 + dismissed_reason: *549 + dismissed_comment: *550 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -73362,7 +73853,7 @@ paths: description: Response content: application/json: - schema: *555 + schema: *556 examples: default: value: @@ -73438,7 +73929,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &559 + '403': &560 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -73465,15 +73956,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 responses: '200': description: Response content: application/json: - schema: &556 + schema: &557 type: object properties: status: @@ -73499,13 +73990,13 @@ paths: - description - started_at examples: - default: &557 + default: &558 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &558 + '400': &559 description: Bad Request content: application/json: @@ -73516,7 +74007,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': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73541,29 +74032,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 responses: '200': description: OK content: application/json: - schema: *556 + schema: *557 examples: - default: *557 + default: *558 '202': description: Accepted content: application/json: - schema: *556 + schema: *557 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *558 + '400': *559 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -73595,9 +74086,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: false content: @@ -73642,8 +74133,8 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *558 - '403': *559 + '400': *559 + '403': *560 '404': *6 '422': description: Unprocessable Entity @@ -73667,13 +74158,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 - *19 - *17 - - *560 - *561 + - *562 responses: '200': description: Response @@ -73681,7 +74172,7 @@ paths: application/json: schema: type: array - items: *552 + items: *553 examples: default: value: @@ -73720,7 +74211,7 @@ paths: end_column: 50 classifications: - source - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73754,25 +74245,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: - - *466 - - *467 - - *311 - - *312 + - *469 + - *470 + - *315 + - *316 - *19 - *17 - - *561 + - *562 - 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: *545 + schema: *546 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &564 + schema: &565 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -73793,23 +74284,23 @@ paths: application/json: schema: type: array - items: &565 + items: &566 type: object properties: - ref: *545 - commit_sha: &573 + ref: *546 + commit_sha: &574 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: *562 + analysis_key: *563 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *563 + category: *564 error: type: string example: error reading field xyz @@ -73833,8 +74324,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *564 - tool: *551 + sarif_id: *565 + tool: *552 deletable: type: boolean warning: @@ -73895,7 +74386,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -73931,8 +74422,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: - - *466 - - *467 + - *469 + - *470 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -73945,7 +74436,7 @@ paths: description: Response content: application/json: - schema: *565 + schema: *566 examples: response: summary: application/json response @@ -73999,7 +74490,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *553 + '403': *554 '404': *6 '422': description: Response if analysis could not be processed @@ -74086,8 +74577,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: - - *466 - - *467 + - *469 + - *470 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -74140,7 +74631,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': *559 + '403': *560 '404': *6 '503': *190 x-github: @@ -74162,8 +74653,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -74171,7 +74662,7 @@ paths: application/json: schema: type: array - items: &566 + items: &567 title: CodeQL Database description: A CodeQL database. type: object @@ -74282,7 +74773,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': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -74311,8 +74802,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: - - *466 - - *467 + - *469 + - *470 - name: language in: path description: The language of the CodeQL database. @@ -74324,7 +74815,7 @@ paths: description: Response content: application/json: - schema: *566 + schema: *567 examples: default: value: @@ -74356,9 +74847,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': &600 + '302': &601 description: Found - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -74380,8 +74871,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *466 - - *467 + - *469 + - *470 - name: language in: path description: The language of the CodeQL database. @@ -74391,7 +74882,7 @@ paths: responses: '204': description: Response - '403': *559 + '403': *560 '404': *6 '503': *190 x-github: @@ -74419,8 +74910,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -74429,7 +74920,7 @@ paths: type: object additionalProperties: false properties: - language: &567 + language: &568 type: string description: The language targeted by the CodeQL query enum: @@ -74508,7 +74999,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &571 + schema: &572 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -74518,7 +75009,7 @@ paths: description: The ID of the variant analysis. controller_repo: *115 actor: *4 - query_language: *567 + query_language: *568 query_pack_url: type: string description: The download url for the query pack. @@ -74565,7 +75056,7 @@ paths: items: type: object properties: - repository: &568 + repository: &569 title: Repository Identifier description: Repository Identifier type: object @@ -74601,7 +75092,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &572 + analysis_status: &573 type: string description: The new status of the CodeQL variant analysis repository task. @@ -74633,7 +75124,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &569 + access_mismatch_repos: &570 type: object properties: repository_count: @@ -74647,7 +75138,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: *568 + items: *569 required: - repository_count - repositories @@ -74669,8 +75160,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *569 - over_limit_repos: *569 + no_codeql_db_repos: *570 + over_limit_repos: *570 required: - access_mismatch_repos - not_found_repos @@ -74686,7 +75177,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &570 + value: &571 summary: Default response value: id: 1 @@ -74838,10 +75329,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *570 + value: *571 repository_lists: summary: Response for a successful variant analysis submission - value: *570 + value: *571 '404': *6 '422': description: Unable to process variant analysis submission @@ -74869,8 +75360,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: - - *466 - - *467 + - *469 + - *470 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -74882,9 +75373,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *572 examples: - default: *570 + default: *571 '404': *6 '503': *190 x-github: @@ -74907,7 +75398,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: - - *466 + - *469 - name: repo in: path description: The name of the controller repository. @@ -74942,7 +75433,7 @@ paths: type: object properties: repository: *115 - analysis_status: *572 + analysis_status: *573 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -75067,8 +75558,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75153,7 +75644,7 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *553 + '403': *554 '404': *6 '503': *190 x-github: @@ -75174,8 +75665,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -75242,7 +75733,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -75267,7 +75758,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *559 + '403': *560 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -75338,8 +75829,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -75347,7 +75838,7 @@ paths: schema: type: object properties: - commit_sha: *573 + commit_sha: *574 ref: type: string description: |- @@ -75405,7 +75896,7 @@ paths: schema: type: object properties: - id: *564 + id: *565 url: type: string description: The REST API URL for checking the status of the upload. @@ -75419,7 +75910,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': *559 + '403': *560 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -75442,8 +75933,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: - - *466 - - *467 + - *469 + - *470 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -75489,7 +75980,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': *553 + '403': *554 '404': description: Not Found if the sarif id does not match any upload '503': *190 @@ -75514,8 +76005,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75596,8 +76087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *466 - - *467 + - *469 + - *470 - 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 @@ -75717,8 +76208,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -75734,7 +76225,7 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: default: value: @@ -76032,8 +76523,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -76096,17 +76587,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '400': *14 '401': *25 '403': *29 @@ -76135,8 +76626,8 @@ paths: parameters: - *17 - *19 - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -76200,8 +76691,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: - - *466 - - *467 + - *469 + - *470 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -76236,14 +76727,14 @@ paths: type: integer machines: type: array - items: &819 + items: &821 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *575 - required: *576 + properties: *576 + required: *577 examples: - default: &820 + default: &822 value: total_count: 2 machines: @@ -76283,8 +76774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *466 - - *467 + - *469 + - *470 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -76368,8 +76859,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: - - *466 - - *467 + - *469 + - *470 - 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 @@ -76435,8 +76926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -76454,7 +76945,7 @@ paths: type: integer secrets: type: array - items: &580 + items: &581 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -76474,7 +76965,7 @@ paths: - created_at - updated_at examples: - default: *577 + default: *578 headers: Link: *43 x-github: @@ -76497,16 +76988,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *578 + schema: *579 examples: - default: *579 + default: *580 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -76526,17 +77017,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *580 + schema: *581 examples: - default: *581 + default: *582 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76556,9 +77047,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: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -76586,7 +77077,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -76610,9 +77101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -76640,8 +77131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *466 - - *467 + - *469 + - *470 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -76683,7 +77174,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &582 + properties: &583 login: type: string example: octocat @@ -76776,7 +77267,7 @@ paths: user_view_type: type: string example: public - required: &583 + required: &584 - avatar_url - events_url - followers_url @@ -76850,8 +77341,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: - - *466 - - *467 + - *469 + - *470 - *138 responses: '204': @@ -76898,8 +77389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *466 - - *467 + - *469 + - *470 - *138 requestBody: required: false @@ -76926,7 +77417,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &658 + schema: &659 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -76937,7 +77428,7 @@ paths: example: 42 type: integer format: int64 - repository: *280 + repository: *284 invitee: title: Simple User description: A GitHub user. @@ -77115,7 +77606,7 @@ paths: - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts content: application/json: - schema: *255 + schema: *259 '403': *29 x-github: triggersNotification: true @@ -77155,8 +77646,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *466 - - *467 + - *469 + - *470 - *138 responses: '204': @@ -77188,8 +77679,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *466 - - *467 + - *469 + - *470 - *138 responses: '200': @@ -77210,8 +77701,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *582 - required: *583 + properties: *583 + required: *584 nullable: true required: - permission @@ -77266,8 +77757,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -77277,7 +77768,7 @@ paths: application/json: schema: type: array - items: &584 + items: &585 title: Commit Comment description: Commit Comment type: object @@ -77318,8 +77809,8 @@ paths: updated_at: type: string format: date-time - author_association: *213 - reactions: *214 + author_association: *214 + reactions: *215 required: - url - html_url @@ -77335,7 +77826,7 @@ paths: - created_at - updated_at examples: - default: &587 + default: &588 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77394,17 +77885,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: &588 + default: &589 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -77461,9 +77952,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -77485,7 +77976,7 @@ paths: description: Response content: application/json: - schema: *584 + schema: *585 examples: default: value: @@ -77536,9 +78027,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -77559,9 +78050,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -77587,9 +78078,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -77610,9 +78101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -77644,16 +78135,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -77675,10 +78166,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -77727,8 +78218,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *466 - - *467 + - *469 + - *470 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -77784,9 +78275,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: &710 + default: &712 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -77880,9 +78371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *466 - - *467 - - &586 + - *469 + - *470 + - &587 name: commit_sha description: The SHA of the commit. in: path @@ -77954,9 +78445,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 - *17 - *19 responses: @@ -77966,9 +78457,9 @@ paths: application/json: schema: type: array - items: *584 + items: *585 examples: - default: *587 + default: *588 headers: Link: *43 x-github: @@ -77996,9 +78487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 requestBody: required: true content: @@ -78033,9 +78524,9 @@ paths: description: Response content: application/json: - schema: *584 + schema: *585 examples: - default: *588 + default: *589 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -78063,9 +78554,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: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 - *17 - *19 responses: @@ -78075,9 +78566,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: &702 + default: &704 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -78614,11 +79105,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 - - &590 + - &591 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)" @@ -78633,9 +79124,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *586 examples: - default: &687 + default: &689 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -78748,11 +79239,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: - - *466 - - *467 - - *590 + - *469 + - *470 - *591 - *592 + - *593 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -78786,9 +79277,9 @@ paths: type: integer check_runs: type: array - items: *537 + items: *538 examples: - default: *593 + default: *594 headers: Link: *43 x-github: @@ -78813,9 +79304,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: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -78823,7 +79314,7 @@ paths: schema: type: integer example: 1 - - *591 + - *592 - *17 - *19 responses: @@ -78841,7 +79332,7 @@ paths: type: integer check_suites: type: array - items: *542 + items: *543 examples: default: value: @@ -79041,9 +79532,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: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - *17 - *19 responses: @@ -79110,7 +79601,7 @@ paths: type: string total_count: type: integer - repository: *280 + repository: *284 commit_url: type: string format: uri @@ -79241,9 +79732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *466 - - *467 - - *590 + - *469 + - *470 + - *591 - *17 - *19 responses: @@ -79253,7 +79744,7 @@ paths: application/json: schema: type: array - items: &764 + items: &766 title: Status description: The status of a commit. type: object @@ -79334,7 +79825,7 @@ paths: site_admin: false headers: Link: *43 - '301': *480 + '301': *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79362,8 +79853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -79392,20 +79883,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *594 - required: *595 + properties: *595 + required: *596 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &596 + properties: &597 url: type: string format: uri html_url: type: string format: uri - required: &597 + required: &598 - url - html_url nullable: true @@ -79413,32 +79904,32 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true contributing: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true readme: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true issue_template: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true pull_request_template: title: Community Health File type: object - properties: *596 - required: *597 + properties: *597 + required: *598 nullable: true required: - code_of_conduct @@ -79565,8 +80056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 - name: basehead @@ -79609,8 +80100,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *585 - merge_base_commit: *585 + base_commit: *586 + merge_base_commit: *586 status: type: string enum: @@ -79630,10 +80121,10 @@ paths: example: 6 commits: type: array - items: *585 + items: *586 files: type: array - items: *598 + items: *599 required: - url - html_url @@ -79919,8 +80410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80063,7 +80554,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &599 + response-if-content-is-a-file: &600 summary: Response if content is a file value: type: file @@ -80195,7 +80686,7 @@ paths: - size - type - url - - &715 + - &717 title: Content File description: Content File type: object @@ -80396,7 +80887,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *599 + response-if-content-is-a-file: *600 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -80465,7 +80956,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *29 - '302': *600 + '302': *601 '304': *37 x-github: githubCloudOnly: false @@ -80488,8 +80979,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80582,7 +81073,7 @@ paths: description: Response content: application/json: - schema: &601 + schema: &602 title: File Commit description: File Commit type: object @@ -80734,7 +81225,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: example-for-creating-a-file: value: @@ -80788,7 +81279,7 @@ paths: schema: oneOf: - *3 - - &640 + - &641 description: Repository rule violation was detected type: object properties: @@ -80809,7 +81300,7 @@ paths: items: type: object properties: - placeholder_id: &756 + placeholder_id: &758 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -80841,8 +81332,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *466 - - *467 + - *469 + - *470 - name: path description: path parameter in: path @@ -80903,7 +81394,7 @@ paths: description: Response content: application/json: - schema: *601 + schema: *602 examples: default: value: @@ -80958,8 +81449,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *466 - - *467 + - *469 + - *470 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -81082,22 +81573,22 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *466 - - *467 - - *327 - - *328 - - *329 - - *330 + - *469 + - *470 + - *331 + - *332 + - *333 + - *334 - 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 - - *331 - - *602 - - *332 - - *333 + - *335 + - *603 + - *336 + - *337 - *106 - name: per_page description: The number of results per page (max 100). For more information, @@ -81116,7 +81607,7 @@ paths: application/json: schema: type: array - items: &605 + items: &606 type: object description: A Dependabot alert. properties: @@ -81162,7 +81653,7 @@ paths: - unknown - direct - transitive - security_advisory: *603 + security_advisory: *604 security_vulnerability: *127 url: *128 html_url: *129 @@ -81193,7 +81684,7 @@ paths: nullable: true maxLength: 280 fixed_at: *133 - auto_dismissed_at: *604 + auto_dismissed_at: *605 required: - number - state @@ -81423,9 +81914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *466 - - *467 - - &606 + - *469 + - *470 + - &607 name: alert_number in: path description: |- @@ -81440,7 +81931,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -81553,9 +82044,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *466 - - *467 - - *606 + - *469 + - *470 + - *607 requestBody: required: true content: @@ -81600,7 +82091,7 @@ paths: description: Response content: application/json: - schema: *605 + schema: *606 examples: default: value: @@ -81729,8 +82220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -81748,7 +82239,7 @@ paths: type: integer secrets: type: array - items: &609 + items: &610 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -81801,16 +82292,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *607 + schema: *608 examples: - default: *608 + default: *609 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81830,15 +82321,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '200': description: Response content: application/json: - schema: *609 + schema: *610 examples: default: value: @@ -81864,9 +82355,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 requestBody: required: true content: @@ -81894,7 +82385,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -81918,9 +82409,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *466 - - *467 - - *290 + - *469 + - *470 + - *294 responses: '204': description: Response @@ -81942,8 +82433,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: - - *466 - - *467 + - *469 + - *470 - 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 @@ -82103,8 +82594,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -82343,8 +82834,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -82419,7 +82910,7 @@ paths: - version - url additionalProperties: false - metadata: &610 + metadata: &611 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82452,7 +82943,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *610 + metadata: *611 resolved: type: object description: A collection of resolved package dependencies. @@ -82465,7 +82956,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *610 + metadata: *611 relationship: type: string description: A notation of whether a dependency is requested @@ -82594,8 +83085,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *466 - - *467 + - *469 + - *470 - name: sha description: The SHA recorded at creation time. in: query @@ -82635,9 +83126,9 @@ paths: application/json: schema: type: array - items: *611 + items: *612 examples: - default: *612 + default: *613 headers: Link: *43 x-github: @@ -82703,8 +83194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -82785,7 +83276,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: simple-example: summary: Simple example @@ -82858,9 +83349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *466 - - *467 - - &613 + - *469 + - *470 + - &614 name: deployment_id description: deployment_id parameter in: path @@ -82872,7 +83363,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *612 examples: default: value: @@ -82937,9 +83428,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 responses: '204': description: Response @@ -82961,9 +83452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 - *17 - *19 responses: @@ -82973,7 +83464,7 @@ paths: application/json: schema: type: array - items: &614 + items: &615 title: Deployment Status description: The status of a deployment. type: object @@ -83064,8 +83555,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -83134,9 +83625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 requestBody: required: true content: @@ -83211,9 +83702,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: &615 + default: &616 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -83269,9 +83760,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *466 - - *467 - - *613 + - *469 + - *470 + - *614 - name: status_id in: path required: true @@ -83282,9 +83773,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *615 examples: - default: *615 + default: *616 '404': *6 x-github: githubCloudOnly: false @@ -83311,12 +83802,12 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 - - *616 + - *469 + - *470 - *617 - *618 - *619 + - *620 - *17 - *19 responses: @@ -83326,9 +83817,9 @@ paths: application/json: schema: type: array - items: *620 + items: *621 examples: - default: *621 + default: *622 '404': *6 '403': *29 '500': *40 @@ -83352,8 +83843,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83365,7 +83856,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *620 + schema: *621 examples: default: value: @@ -83421,8 +83912,8 @@ paths: category: code-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83481,12 +83972,12 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - *99 - *100 - *101 - - *622 + - *623 - *17 - *19 responses: @@ -83496,9 +83987,9 @@ paths: application/json: schema: type: array - items: *623 + items: *624 examples: - default: *624 + default: *625 '404': *6 '403': *29 '500': *40 @@ -83523,8 +84014,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83536,7 +84027,7 @@ paths: description: A single dismissal request. content: application/json: - schema: *623 + schema: *624 examples: default: value: @@ -83594,8 +84085,8 @@ paths: category: secret-scanning subcategory: alert-dismissal-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: alert_number in: path required: true @@ -83664,8 +84155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -83722,8 +84213,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -83740,7 +84231,7 @@ paths: type: integer environments: type: array - items: &626 + items: &627 title: Environment description: Details of a deployment environment type: object @@ -83792,7 +84283,7 @@ paths: type: type: string example: wait_timer - wait_timer: &628 + wait_timer: &629 type: integer example: 30 description: The amount of time to delay a job after @@ -83829,11 +84320,11 @@ paths: items: type: object properties: - type: *625 + type: *626 reviewer: anyOf: - *4 - - *307 + - *311 required: - id - node_id @@ -83853,7 +84344,7 @@ paths: - id - node_id - type - deployment_branch_policy: &629 + deployment_branch_policy: &630 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -83969,9 +84460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *466 - - *467 - - &627 + - *469 + - *470 + - &628 name: environment_name in: path required: true @@ -83984,9 +84475,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: &630 + default: &631 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -84070,9 +84561,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: false content: @@ -84081,7 +84572,7 @@ paths: type: object nullable: true properties: - wait_timer: *628 + wait_timer: *629 prevent_self_review: type: boolean example: false @@ -84098,13 +84589,13 @@ paths: items: type: object properties: - type: *625 + type: *626 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *629 + deployment_branch_policy: *630 additionalProperties: false examples: default: @@ -84124,9 +84615,9 @@ paths: description: Response content: application/json: - schema: *626 + schema: *627 examples: - default: *630 + default: *631 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -84150,9 +84641,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 responses: '204': description: Default response @@ -84177,9 +84668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 - *17 - *19 responses: @@ -84197,7 +84688,7 @@ paths: example: 2 branch_policies: type: array - items: &631 + items: &632 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -84254,9 +84745,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: true content: @@ -84302,9 +84793,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - example-wildcard: &632 + example-wildcard: &633 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -84346,10 +84837,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - &633 + - *469 + - *470 + - *628 + - &634 name: branch_policy_id in: path required: true @@ -84361,9 +84852,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84382,10 +84873,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - *633 + - *469 + - *470 + - *628 + - *634 requestBody: required: true content: @@ -84413,9 +84904,9 @@ paths: description: Response content: application/json: - schema: *631 + schema: *632 examples: - default: *632 + default: *633 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84434,10 +84925,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *466 - - *467 - - *627 - - *633 + - *469 + - *470 + - *628 + - *634 responses: '204': description: Response @@ -84462,9 +84953,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 responses: '200': description: List of deployment protection rules @@ -84480,7 +84971,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &634 + items: &635 title: Deployment protection rule description: Deployment protection rule type: object @@ -84499,7 +84990,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &635 + app: &636 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -84598,9 +85089,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 requestBody: content: application/json: @@ -84621,9 +85112,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *634 + schema: *635 examples: - default: &636 + default: &637 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -84658,9 +85149,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: - - *627 - - *467 - - *466 + - *628 + - *470 + - *469 - *19 - *17 responses: @@ -84679,7 +85170,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *635 + items: *636 examples: default: value: @@ -84714,10 +85205,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: - - *466 - - *467 - - *627 - - &637 + - *469 + - *470 + - *628 + - &638 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -84729,9 +85220,9 @@ paths: description: Response content: application/json: - schema: *634 + schema: *635 examples: - default: *636 + default: *637 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84752,10 +85243,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: - - *627 - - *467 - - *466 - - *637 + - *628 + - *470 + - *469 + - *638 responses: '204': description: Response @@ -84781,9 +85272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 - *17 - *19 responses: @@ -84801,9 +85292,9 @@ paths: type: integer secrets: type: array - items: *503 + items: *504 examples: - default: *504 + default: *505 headers: Link: *43 x-github: @@ -84828,17 +85319,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 responses: '200': description: Response content: application/json: - schema: *505 + schema: *506 examples: - default: *506 + default: *507 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84860,18 +85351,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 responses: '200': description: Response content: application/json: - schema: *503 + schema: *504 examples: - default: *638 + default: *639 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84893,10 +85384,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 requestBody: required: true content: @@ -84927,7 +85418,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -84953,10 +85444,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *466 - - *467 - - *627 - - *290 + - *469 + - *470 + - *628 + - *294 responses: '204': description: Default response @@ -84981,10 +85472,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *466 - - *467 - - *627 - - *490 + - *469 + - *470 + - *628 + - *491 - *19 responses: '200': @@ -85001,9 +85492,9 @@ paths: type: integer variables: type: array - items: *507 + items: *508 examples: - default: *508 + default: *509 headers: Link: *43 x-github: @@ -85026,9 +85517,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *466 - - *467 - - *627 + - *469 + - *470 + - *628 requestBody: required: true content: @@ -85055,7 +85546,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -85080,18 +85571,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *466 - - *467 - - *627 - - *293 + - *469 + - *470 + - *628 + - *297 responses: '200': description: Response content: application/json: - schema: *507 + schema: *508 examples: - default: *639 + default: *640 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85112,10 +85603,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *466 - - *467 - - *293 - - *627 + - *469 + - *470 + - *297 + - *628 requestBody: required: true content: @@ -85157,10 +85648,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *466 - - *467 - - *293 - - *627 + - *469 + - *470 + - *297 + - *628 responses: '204': description: Response @@ -85182,8 +85673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -85193,7 +85684,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: 200-response: value: @@ -85251,8 +85742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *466 - - *467 + - *469 + - *470 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -85274,7 +85765,7 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: default: value: @@ -85411,8 +85902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -85444,9 +85935,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 '400': *14 '422': *15 '403': *29 @@ -85467,8 +85958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -85527,8 +86018,8 @@ paths: application/json: schema: oneOf: - - *255 - - *640 + - *259 + - *641 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85553,8 +86044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *466 - - *467 + - *469 + - *470 - name: file_sha in: path required: true @@ -85653,8 +86144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -85763,7 +86254,7 @@ paths: description: Response content: application/json: - schema: &641 + schema: &642 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -85977,15 +86468,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *466 - - *467 - - *586 + - *469 + - *470 + - *587 responses: '200': description: Response content: application/json: - schema: *641 + schema: *642 examples: default: value: @@ -86041,9 +86532,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *466 - - *467 - - &642 + - *469 + - *470 + - &643 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. @@ -86060,7 +86551,7 @@ paths: application/json: schema: type: array - items: &643 + items: &644 title: Git Reference description: Git references within a repository type: object @@ -86135,17 +86626,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 responses: '200': description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: &644 + default: &645 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -86174,8 +86665,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86204,9 +86695,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA @@ -86232,9 +86723,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 requestBody: required: true content: @@ -86263,9 +86754,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *644 examples: - default: *644 + default: *645 '422': *15 '409': *114 x-github: @@ -86283,9 +86774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *466 - - *467 - - *642 + - *469 + - *470 + - *643 responses: '204': description: Response @@ -86340,8 +86831,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86408,7 +86899,7 @@ paths: description: Response content: application/json: - schema: &646 + schema: &647 title: Git Tag description: Metadata for a Git tag type: object @@ -86459,7 +86950,7 @@ paths: - sha - type - url - verification: *645 + verification: *646 required: - sha - url @@ -86469,7 +86960,7 @@ paths: - tag - message examples: - default: &647 + default: &648 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -86542,8 +87033,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *466 - - *467 + - *469 + - *470 - name: tag_sha in: path required: true @@ -86554,9 +87045,9 @@ paths: description: Response content: application/json: - schema: *646 + schema: *647 examples: - default: *647 + default: *648 '404': *6 '409': *114 x-github: @@ -86580,8 +87071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -86654,7 +87145,7 @@ paths: description: Response content: application/json: - schema: &648 + schema: &649 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -86750,8 +87241,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *466 - - *467 + - *469 + - *470 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -86774,7 +87265,7 @@ paths: description: Response content: application/json: - schema: *648 + schema: *649 examples: default-response: summary: Default response @@ -86833,8 +87324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -86844,7 +87335,7 @@ paths: application/json: schema: type: array - items: &649 + items: &650 title: Webhook description: Webhooks for repositories. type: object @@ -86898,7 +87389,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &902 + last_response: &904 title: Hook Response type: object properties: @@ -86972,8 +87463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -87025,9 +87516,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: &650 + default: &651 value: type: Repository id: 12345678 @@ -87075,17 +87566,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '200': description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '404': *6 x-github: githubCloudOnly: false @@ -87105,9 +87596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 requestBody: required: true content: @@ -87152,9 +87643,9 @@ paths: description: Response content: application/json: - schema: *649 + schema: *650 examples: - default: *650 + default: *651 '422': *15 '404': *6 x-github: @@ -87175,9 +87666,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87201,9 +87692,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '200': description: Response @@ -87230,9 +87721,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 requestBody: required: false content: @@ -87276,11 +87767,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *17 - - *342 + - *346 responses: '200': description: Response @@ -87288,9 +87779,9 @@ paths: application/json: schema: type: array - items: *343 + items: *347 examples: - default: *344 + default: *348 '400': *14 '422': *15 x-github: @@ -87309,18 +87800,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *16 responses: '200': description: Response content: application/json: - schema: *345 + schema: *349 examples: - default: *346 + default: *350 '400': *14 '422': *15 x-github: @@ -87339,9 +87830,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: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 - *16 responses: '202': *39 @@ -87364,9 +87855,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87391,9 +87882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *466 - - *467 - - *341 + - *469 + - *470 + - *345 responses: '204': description: Response @@ -87416,8 +87907,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response if immutable releases are enabled @@ -87463,8 +87954,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-immutable-releases parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '409': *114 @@ -87484,8 +87975,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-immutable-releases parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '409': *114 @@ -87542,14 +88033,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &651 + schema: &652 title: Import description: A repository import from an external source. type: object @@ -87648,7 +88139,7 @@ paths: - html_url - authors_url examples: - default: &654 + default: &655 value: vcs: subversion use_lfs: true @@ -87664,7 +88155,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': &652 + '503': &653 description: Unavailable due to service under maintenance. content: application/json: @@ -87693,8 +88184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -87742,7 +88233,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: default: value: @@ -87767,7 +88258,7 @@ paths: type: string '422': *15 '404': *6 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87795,8 +88286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -87845,7 +88336,7 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: example-1: summary: Example 1 @@ -87893,7 +88384,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': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87916,12 +88407,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87947,9 +88438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *466 - - *467 - - &841 + - *469 + - *470 + - &843 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -87963,7 +88454,7 @@ paths: application/json: schema: type: array - items: &653 + items: &654 title: Porter Author description: Porter Author type: object @@ -88017,7 +88508,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': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88042,8 +88533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *466 - - *467 + - *469 + - *470 - name: author_id in: path required: true @@ -88073,7 +88564,7 @@ paths: description: Response content: application/json: - schema: *653 + schema: *654 examples: default: value: @@ -88086,7 +88577,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88110,8 +88601,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88152,7 +88643,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88180,8 +88671,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -88208,11 +88699,11 @@ paths: description: Response content: application/json: - schema: *651 + schema: *652 examples: - default: *654 + default: *655 '422': *15 - '503': *652 + '503': *653 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88235,8 +88726,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88244,8 +88735,8 @@ paths: application/json: schema: *22 examples: - default: *655 - '301': *480 + default: *656 + '301': *481 '404': *6 x-github: githubCloudOnly: false @@ -88265,8 +88756,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -88274,12 +88765,12 @@ paths: application/json: schema: anyOf: - - *359 + - *363 - type: object properties: {} additionalProperties: false examples: - default: &657 + default: &658 value: limit: collaborators_only origin: repository @@ -88304,13 +88795,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: application/json: - schema: *656 + schema: *657 examples: default: summary: Example request body @@ -88322,9 +88813,9 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *657 + default: *658 '409': description: Response x-github: @@ -88346,8 +88837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -88370,8 +88861,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -88381,9 +88872,9 @@ paths: application/json: schema: type: array - items: *658 + items: *659 examples: - default: &834 + default: &836 value: - id: 1 repository: @@ -88514,9 +89005,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *466 - - *467 - - *363 + - *469 + - *470 + - *367 requestBody: required: false content: @@ -88545,7 +89036,7 @@ paths: description: Response content: application/json: - schema: *658 + schema: *659 examples: default: value: @@ -88676,9 +89167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *466 - - *467 - - *363 + - *469 + - *470 + - *367 responses: '204': description: Response @@ -88709,8 +89200,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *466 - - *467 + - *469 + - *470 - 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 @@ -88758,7 +89249,7 @@ paths: required: false schema: type: string - - *367 + - *371 - name: sort description: What to sort results by. in: query @@ -88771,7 +89262,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -88781,9 +89272,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: &667 + default: &669 value: - id: 1 node_id: MDU6SXNzdWUx @@ -88931,7 +89422,7 @@ paths: state_reason: completed headers: Link: *43 - '301': *480 + '301': *481 '422': *15 '404': *6 x-github: @@ -88960,8 +89451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -89043,9 +89534,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: &664 + default: &666 value: id: 1 node_id: MDU6SXNzdWUx @@ -89201,7 +89692,7 @@ paths: '422': *15 '503': *190 '404': *6 - '410': *477 + '410': *660 x-github: triggersNotification: true githubCloudOnly: false @@ -89229,9 +89720,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *466 - - *467 - - *236 + - *469 + - *470 + - *237 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -89241,7 +89732,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -89251,9 +89742,9 @@ paths: application/json: schema: type: array - items: *659 + items: *661 examples: - default: &666 + default: &668 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89311,17 +89802,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: &660 + default: &662 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -89375,9 +89866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -89399,9 +89890,9 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: *660 + default: *662 '422': *15 x-github: githubCloudOnly: false @@ -89419,9 +89910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -89441,9 +89932,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -89469,9 +89960,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -89492,9 +89983,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -89526,16 +90017,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -89557,10 +90048,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -89580,8 +90071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -89591,7 +90082,7 @@ paths: application/json: schema: type: array - items: &663 + items: &665 title: Issue Event description: Issue Event type: object @@ -89634,8 +90125,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *661 - required: *662 + properties: *663 + required: *664 nullable: true label: title: Issue Event Label @@ -89679,7 +90170,7 @@ paths: properties: *20 required: *21 nullable: true - requested_team: *307 + requested_team: *311 dismissed_review: title: Issue Event Dismissed Review type: object @@ -89744,7 +90235,7 @@ paths: required: - from - to - author_association: *213 + author_association: *214 lock_reason: type: string nullable: true @@ -89757,8 +90248,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 required: - id - node_id @@ -89942,8 +90433,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *466 - - *467 + - *469 + - *470 - name: event_id in: path required: true @@ -89954,7 +90445,7 @@ paths: description: Response content: application/json: - schema: *663 + schema: *665 examples: default: value: @@ -90147,7 +90638,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *477 + '410': *660 '403': *29 x-github: githubCloudOnly: false @@ -90181,9 +90672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *466 - - *467 - - &665 + - *469 + - *470 + - &667 name: issue_number description: The number that identifies the issue. in: path @@ -90195,12 +90686,12 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '404': *6 - '410': *477 + '410': *660 '304': *37 x-github: githubCloudOnly: false @@ -90225,9 +90716,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -90331,15 +90822,15 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 '422': *15 '503': *190 '403': *29 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90357,9 +90848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -90385,9 +90876,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90403,9 +90894,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: content: application/json: @@ -90430,9 +90921,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90454,9 +90945,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: assignee in: path required: true @@ -90496,10 +90987,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *466 - - *467 - - *665 - - *216 + - *469 + - *470 + - *667 + - *217 - *17 - *19 responses: @@ -90509,13 +91000,13 @@ paths: application/json: schema: type: array - items: *659 + items: *661 examples: - default: *666 + default: *668 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90544,9 +91035,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -90568,16 +91059,16 @@ paths: description: Response content: application/json: - schema: *659 + schema: *661 examples: - default: *660 + default: *662 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -90605,9 +91096,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90617,14 +91108,14 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90652,9 +91143,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -90676,17 +91167,17 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *480 + '301': *481 '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -90717,9 +91208,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -90731,15 +91222,15 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '400': *14 '401': *25 '403': *29 '404': *6 - '410': *477 + '410': *660 x-github: triggersNotification: true githubCloudOnly: false @@ -90765,9 +91256,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: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90777,14 +91268,14 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90801,9 +91292,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -90817,7 +91308,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &670 + - &672 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -90848,8 +91339,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 label: type: object properties: @@ -90871,7 +91362,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &671 + - &673 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -90902,8 +91393,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 label: type: object properties: @@ -90991,8 +91482,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 assigner: *4 required: @@ -91007,7 +91498,7 @@ paths: - performed_via_github_app - assignee - assigner - - &672 + - &674 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -91038,8 +91529,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 milestone: type: object properties: @@ -91058,7 +91549,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &673 + - &675 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -91089,8 +91580,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 milestone: type: object properties: @@ -91109,7 +91600,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &674 + - &676 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -91140,8 +91631,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 rename: type: object properties: @@ -91163,7 +91654,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &675 + - &677 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -91194,10 +91685,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 review_requester: *4 - requested_team: *307 + requested_team: *311 requested_reviewer: *4 required: - review_requester @@ -91210,7 +91701,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &676 + - &678 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -91241,10 +91732,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 review_requester: *4 - requested_team: *307 + requested_team: *311 requested_reviewer: *4 required: - review_requester @@ -91257,7 +91748,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &677 + - &679 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -91288,8 +91779,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 dismissed_review: type: object properties: @@ -91317,7 +91808,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &678 + - &680 title: Locked Issue Event description: Locked Issue Event type: object @@ -91348,8 +91839,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 lock_reason: type: string example: '"off-topic"' @@ -91365,7 +91856,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &679 + - &681 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -91396,8 +91887,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91431,7 +91922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &680 + - &682 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -91462,8 +91953,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91497,7 +91988,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &681 + - &683 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -91528,8 +92019,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 project_card: type: object properties: @@ -91563,7 +92054,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &682 + - &684 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -91654,7 +92145,7 @@ paths: color: red headers: Link: *43 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91671,9 +92162,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -91683,7 +92174,7 @@ paths: application/json: schema: type: array - items: &668 + items: &670 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -91730,7 +92221,7 @@ paths: - color - default examples: - default: &669 + default: &671 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -91748,9 +92239,9 @@ paths: default: false headers: Link: *43 - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91767,9 +92258,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -91828,12 +92319,12 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 - '301': *480 + default: *671 + '301': *481 '404': *6 - '410': *477 + '410': *660 '422': *15 x-github: githubCloudOnly: false @@ -91850,9 +92341,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -91912,12 +92403,12 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 - '301': *480 + default: *671 + '301': *481 '404': *6 - '410': *477 + '410': *660 '422': *15 x-github: githubCloudOnly: false @@ -91934,15 +92425,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '204': description: Response - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91961,9 +92452,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - name: name in: path required: true @@ -91976,7 +92467,7 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: default: value: @@ -91987,9 +92478,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *480 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92009,9 +92500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: false content: @@ -92039,7 +92530,7 @@ paths: '204': description: Response '403': *29 - '410': *477 + '410': *660 '404': *6 '422': *15 x-github: @@ -92057,9 +92548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '204': description: Response @@ -92089,20 +92580,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#get-parent-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 responses: '200': description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 - '301': *480 + default: *666 + '301': *481 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92119,9 +92610,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - 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. @@ -92147,13 +92638,13 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92171,9 +92662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92205,16 +92696,16 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -92236,10 +92727,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *466 - - *467 - - *665 - - *458 + - *469 + - *470 + - *667 + - *461 responses: '204': description: Response @@ -92268,9 +92759,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92292,9 +92783,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -92327,9 +92818,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -92339,13 +92830,13 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *667 + default: *669 headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -92373,9 +92864,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92402,16 +92893,16 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *29 - '410': *477 + '410': *660 '422': *15 '404': *6 x-github: @@ -92431,9 +92922,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 requestBody: required: true content: @@ -92464,9 +92955,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *227 examples: - default: *664 + default: *666 '403': *29 '404': *6 '422': *7 @@ -92488,9 +92979,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *466 - - *467 - - *665 + - *469 + - *470 + - *667 - *17 - *19 responses: @@ -92505,8 +92996,6 @@ paths: description: Timeline Event type: object anyOf: - - *670 - - *671 - *672 - *673 - *674 @@ -92518,6 +93007,8 @@ paths: - *680 - *681 - *682 + - *683 + - *684 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -92560,7 +93051,7 @@ paths: issue_url: type: string format: uri - author_association: *213 + author_association: *214 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -92570,9 +93061,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - event - actor @@ -92603,7 +93094,7 @@ paths: properties: type: type: string - issue: *226 + issue: *227 required: - event - created_at @@ -92803,7 +93294,7 @@ paths: type: string body_text: type: string - author_association: *213 + author_association: *214 required: - event - id @@ -92826,7 +93317,7 @@ paths: type: string comments: type: array - items: &704 + items: &706 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -92915,7 +93406,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *213 + author_association: *214 _links: type: object properties: @@ -92999,7 +93490,7 @@ paths: enum: - line - file - reactions: *214 + reactions: *215 body_html: type: string example: '"

comment body

"' @@ -93035,7 +93526,7 @@ paths: type: string comments: type: array - items: *584 + items: *585 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -93066,8 +93557,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 required: - id @@ -93110,8 +93601,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 assignee: *4 required: - id @@ -93154,8 +93645,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 state_reason: type: string nullable: true @@ -93324,7 +93815,7 @@ paths: headers: Link: *43 '404': *6 - '410': *477 + '410': *660 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93341,8 +93832,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -93352,7 +93843,7 @@ paths: application/json: schema: type: array - items: &683 + items: &685 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -93418,8 +93909,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -93455,9 +93946,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: - default: &684 + default: &686 value: id: 1 key: ssh-rsa AAA... @@ -93491,9 +93982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *466 - - *467 - - &685 + - *469 + - *470 + - &687 name: key_id description: The unique identifier of the key. in: path @@ -93505,9 +93996,9 @@ paths: description: Response content: application/json: - schema: *683 + schema: *685 examples: - default: *684 + default: *686 '404': *6 x-github: githubCloudOnly: false @@ -93525,9 +94016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *466 - - *467 - - *685 + - *469 + - *470 + - *687 responses: '204': description: Response @@ -93547,8 +94038,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -93558,9 +94049,9 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 + default: *671 headers: Link: *43 '404': *6 @@ -93581,8 +94072,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -93618,9 +94109,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: - default: &686 + default: &688 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -93652,8 +94143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93664,9 +94155,9 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: - default: *686 + default: *688 '404': *6 x-github: githubCloudOnly: false @@ -93683,8 +94174,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93723,7 +94214,7 @@ paths: description: Response content: application/json: - schema: *668 + schema: *670 examples: default: value: @@ -93749,8 +94240,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *466 - - *467 + - *469 + - *470 - name: name in: path required: true @@ -93776,8 +94267,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -93813,8 +94304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '202': *39 '403': @@ -93842,8 +94333,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -93869,9 +94360,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *466 - - *467 - - *560 + - *469 + - *470 + - *561 responses: '200': description: Response @@ -93933,8 +94424,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true required: - _links @@ -94016,8 +94507,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94082,8 +94573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94117,9 +94608,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *585 + schema: *586 examples: - default: *687 + default: *689 '204': description: Response when already merged '404': @@ -94144,8 +94635,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *466 - - *467 + - *469 + - *470 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -94186,12 +94677,12 @@ paths: application/json: schema: type: array - items: &688 + items: &690 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 examples: default: value: @@ -94247,8 +94738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94288,9 +94779,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: &689 + default: &691 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -94349,9 +94840,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *466 - - *467 - - &690 + - *469 + - *470 + - &692 name: milestone_number description: The number that identifies the milestone. in: path @@ -94363,9 +94854,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: *689 + default: *691 '404': *6 x-github: githubCloudOnly: false @@ -94382,9 +94873,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 requestBody: required: false content: @@ -94422,9 +94913,9 @@ paths: description: Response content: application/json: - schema: *688 + schema: *690 examples: - default: *689 + default: *691 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94440,9 +94931,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 responses: '204': description: Response @@ -94463,9 +94954,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: - - *466 - - *467 - - *690 + - *469 + - *470 + - *692 - *17 - *19 responses: @@ -94475,9 +94966,9 @@ paths: application/json: schema: type: array - items: *668 + items: *670 examples: - default: *669 + default: *671 headers: Link: *43 x-github: @@ -94496,12 +94987,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: - - *466 - - *467 - - *691 - - *692 - - *216 + - *469 + - *470 - *693 + - *694 + - *217 + - *695 - *17 - *19 responses: @@ -94511,9 +95002,9 @@ paths: application/json: schema: type: array - items: *239 + items: *240 examples: - default: *694 + default: *696 headers: Link: *43 x-github: @@ -94537,8 +95028,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -94596,14 +95087,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: &695 + schema: &697 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -94728,7 +95219,7 @@ paths: - custom_404 - public examples: - default: &696 + default: &698 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -94769,8 +95260,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94824,9 +95315,9 @@ paths: description: Response content: application/json: - schema: *695 + schema: *697 examples: - default: *696 + default: *698 '422': *15 '409': *114 x-github: @@ -94849,8 +95340,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -94957,8 +95448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -94984,8 +95475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -94995,7 +95486,7 @@ paths: application/json: schema: type: array - items: &697 + items: &699 title: Page Build description: Page Build type: object @@ -95089,8 +95580,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *466 - - *467 + - *469 + - *470 responses: '201': description: Response @@ -95135,16 +95626,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: &698 + default: &700 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -95192,8 +95683,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *466 - - *467 + - *469 + - *470 - name: build_id in: path required: true @@ -95204,9 +95695,9 @@ paths: description: Response content: application/json: - schema: *697 + schema: *699 examples: - default: *698 + default: *700 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -95226,8 +95717,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -95332,9 +95823,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: - - *466 - - *467 - - &699 + - *469 + - *470 + - &701 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -95392,9 +95883,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *466 - - *467 - - *699 + - *469 + - *470 + - *701 responses: '204': *150 '404': *6 @@ -95421,8 +95912,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -95653,7 +96144,7 @@ paths: description: Empty response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -95680,8 +96171,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Private vulnerability reporting status @@ -95718,8 +96209,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: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '422': *14 @@ -95740,8 +96231,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: - - *466 - - *467 + - *469 + - *470 responses: '204': *150 '422': *14 @@ -95750,148 +96241,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: - - *466 - - *467 - - 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: *396 - 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: *43 - '401': *25 - '403': *29 - '404': *6 - '410': *477 - '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: - - *466 - - *467 - 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: *396 - examples: - default: *476 - '401': *25 - '403': *29 - '404': *6 - '410': *477 - '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 @@ -95905,8 +96254,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -95916,7 +96265,7 @@ paths: type: array items: *151 examples: - default: *700 + default: *702 '403': *29 '404': *6 x-github: @@ -95938,8 +96287,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -95955,7 +96304,7 @@ paths: required: - properties examples: - default: *701 + default: *703 responses: '204': description: No Content when custom property values are successfully created @@ -95993,8 +96342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *466 - - *467 + - *469 + - *470 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -96054,9 +96403,9 @@ paths: application/json: schema: type: array - items: *589 + items: *590 examples: - default: *702 + default: *704 headers: Link: *43 '304': *37 @@ -96088,8 +96437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -96154,7 +96503,7 @@ paths: description: Response content: application/json: - schema: &706 + schema: &708 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -96265,8 +96614,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true active_lock_reason: type: string @@ -96311,7 +96660,7 @@ paths: nullable: true requested_teams: type: array - items: *433 + items: *436 nullable: true head: type: object @@ -96350,14 +96699,14 @@ paths: _links: type: object properties: - comments: *403 - commits: *403 - statuses: *403 - html: *403 - issue: *403 - review_comments: *403 - review_comment: *403 - self: *403 + comments: *406 + commits: *406 + statuses: *406 + html: *406 + issue: *406 + review_comments: *406 + review_comment: *406 + self: *406 required: - comments - commits @@ -96367,8 +96716,8 @@ paths: - review_comments - review_comment - self - author_association: *213 - auto_merge: *703 + author_association: *214 + auto_merge: *705 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -96460,7 +96809,7 @@ paths: - merged_by - review_comments examples: - default: &707 + default: &709 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -96987,8 +97336,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *466 - - *467 + - *469 + - *470 - name: sort in: query required: false @@ -97007,7 +97356,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -97017,9 +97366,9 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: &709 + default: &711 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97096,17 +97445,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '200': description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: &705 + default: &707 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -97181,9 +97530,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -97205,9 +97554,9 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: - default: *705 + default: *707 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97223,9 +97572,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 responses: '204': description: Response @@ -97246,9 +97595,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 - 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. @@ -97274,9 +97623,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -97297,9 +97646,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: - - *466 - - *467 - - *225 + - *469 + - *470 + - *226 requestBody: required: true content: @@ -97331,16 +97680,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -97362,10 +97711,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *466 - - *467 - - *225 - - *458 + - *469 + - *470 + - *226 + - *461 responses: '204': description: Response @@ -97408,9 +97757,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *466 - - *467 - - &708 + - *469 + - *470 + - &710 name: pull_number description: The number that identifies the pull request. in: path @@ -97423,9 +97772,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '304': *37 '404': *6 '406': @@ -97460,9 +97809,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -97504,9 +97853,9 @@ paths: description: Response content: application/json: - schema: *706 + schema: *708 examples: - default: *707 + default: *709 '422': *15 '403': *29 x-github: @@ -97528,9 +97877,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -97590,17 +97939,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -97630,10 +97979,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: - - *466 - - *467 - - *708 - - *236 + - *469 + - *470 + - *710 + - *237 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -97643,7 +97992,7 @@ paths: enum: - asc - desc - - *216 + - *217 - *17 - *19 responses: @@ -97653,9 +98002,9 @@ paths: application/json: schema: type: array - items: *704 + items: *706 examples: - default: *709 + default: *711 headers: Link: *43 x-github: @@ -97688,9 +98037,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -97795,7 +98144,7 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: example-for-a-multi-line-comment: value: @@ -97883,10 +98232,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: - - *466 - - *467 - - *708 - - *225 + - *469 + - *470 + - *710 + - *226 requestBody: required: true content: @@ -97908,7 +98257,7 @@ paths: description: Response content: application/json: - schema: *704 + schema: *706 examples: default: value: @@ -97994,9 +98343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -98006,9 +98355,9 @@ paths: application/json: schema: type: array - items: *585 + items: *586 examples: - default: *710 + default: *712 headers: Link: *43 x-github: @@ -98038,9 +98387,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -98050,7 +98399,7 @@ paths: application/json: schema: type: array - items: *598 + items: *599 examples: default: value: @@ -98088,9 +98437,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 responses: '204': description: Response if pull request has been merged @@ -98113,9 +98462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -98226,9 +98575,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 responses: '200': description: Response @@ -98244,7 +98593,7 @@ paths: items: *4 teams: type: array - items: *307 + items: *311 required: - users - teams @@ -98303,9 +98652,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -98342,7 +98691,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -98878,9 +99227,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: true content: @@ -98914,7 +99263,7 @@ paths: description: Response content: application/json: - schema: *589 + schema: *590 examples: default: value: @@ -99419,9 +99768,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 - *17 - *19 responses: @@ -99431,7 +99780,7 @@ paths: application/json: schema: type: array - items: &711 + items: &713 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -99500,7 +99849,7 @@ paths: type: string body_text: type: string - author_association: *213 + author_association: *214 required: - id - node_id @@ -99582,9 +99931,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: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -99670,9 +100019,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &713 + default: &715 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99735,10 +100084,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: - - *466 - - *467 - - *708 - - &712 + - *469 + - *470 + - *710 + - &714 name: review_id description: The unique identifier of the review. in: path @@ -99750,9 +100099,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: &714 + default: &716 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -99811,10 +100160,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -99837,7 +100186,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: default: value: @@ -99899,18 +100248,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 responses: '200': description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *713 + default: *715 '422': *7 '404': *6 x-github: @@ -99937,10 +100286,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 - *17 - *19 responses: @@ -100019,13 +100368,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *213 + author_association: *214 _links: type: object properties: - self: *403 - html: *403 - pull_request: *403 + self: *406 + html: *406 + pull_request: *406 required: - self - html @@ -100034,7 +100383,7 @@ paths: type: string body_html: type: string - reactions: *214 + reactions: *215 side: description: The side of the first line of the range for a multi-line comment. @@ -100175,10 +100524,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -100206,7 +100555,7 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: default: value: @@ -100269,10 +100618,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: - - *466 - - *467 - - *708 - - *712 + - *469 + - *470 + - *710 + - *714 requestBody: required: true content: @@ -100307,9 +100656,9 @@ paths: description: Response content: application/json: - schema: *711 + schema: *713 examples: - default: *714 + default: *716 '404': *6 '422': *7 '403': *29 @@ -100331,9 +100680,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *466 - - *467 - - *708 + - *469 + - *470 + - *710 requestBody: required: false content: @@ -100396,8 +100745,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *466 - - *467 + - *469 + - *470 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -100410,9 +100759,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: &716 + default: &718 value: type: file encoding: base64 @@ -100454,8 +100803,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: - - *466 - - *467 + - *469 + - *470 - name: dir description: The alternate path to look for a README file in: path @@ -100475,9 +100824,9 @@ paths: description: Response content: application/json: - schema: *715 + schema: *717 examples: - default: *716 + default: *718 '404': *6 '422': *15 x-github: @@ -100499,8 +100848,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -100510,7 +100859,7 @@ paths: application/json: schema: type: array - items: &717 + items: &719 title: Release description: A release. type: object @@ -100581,7 +100930,7 @@ paths: author: *4 assets: type: array - items: &718 + items: &720 title: Release Asset description: Data related to a release. type: object @@ -100656,7 +101005,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *214 + reactions: *215 required: - assets_url - upload_url @@ -100768,8 +101117,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -100845,9 +101194,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: &721 + default: &723 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -100952,9 +101301,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *466 - - *467 - - &719 + - *469 + - *470 + - &721 name: asset_id description: The unique identifier of the asset. in: path @@ -100966,9 +101315,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: - default: &720 + default: &722 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 @@ -101003,7 +101352,7 @@ paths: type: User site_admin: false '404': *6 - '302': *600 + '302': *601 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101019,9 +101368,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *466 - - *467 - - *719 + - *469 + - *470 + - *721 requestBody: required: false content: @@ -101049,9 +101398,9 @@ paths: description: Response content: application/json: - schema: *718 + schema: *720 examples: - default: *720 + default: *722 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101067,9 +101416,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *466 - - *467 - - *719 + - *469 + - *470 + - *721 responses: '204': description: Response @@ -101093,8 +101442,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -101179,16 +101528,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -101205,8 +101554,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *466 - - *467 + - *469 + - *470 - name: tag description: tag parameter in: path @@ -101219,9 +101568,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 '404': *6 x-github: githubCloudOnly: false @@ -101243,9 +101592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *466 - - *467 - - &722 + - *469 + - *470 + - &724 name: release_id description: The unique identifier of the release. in: path @@ -101259,9 +101608,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: *717 + schema: *719 examples: - default: *721 + default: *723 '401': description: Unauthorized x-github: @@ -101279,9 +101628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 requestBody: required: false content: @@ -101345,9 +101694,9 @@ paths: description: Response content: application/json: - schema: *717 + schema: *719 examples: - default: *721 + default: *723 '404': description: Not Found if the discussion category name is invalid content: @@ -101368,9 +101717,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 responses: '204': description: Response @@ -101390,9 +101739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - *17 - *19 responses: @@ -101402,7 +101751,7 @@ paths: application/json: schema: type: array - items: *718 + items: *720 examples: default: value: @@ -101484,9 +101833,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: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - name: name in: query required: true @@ -101512,7 +101861,7 @@ paths: description: Response for successful upload content: application/json: - schema: *718 + schema: *720 examples: response-for-successful-upload: value: @@ -101567,9 +101916,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 - 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. @@ -101593,9 +101942,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 '404': *6 @@ -101616,9 +101965,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *466 - - *467 - - *722 + - *469 + - *470 + - *724 requestBody: required: true content: @@ -101648,16 +101997,16 @@ paths: description: Reaction exists content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '201': description: Reaction created content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 '422': *15 x-github: githubCloudOnly: false @@ -101679,10 +102028,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *466 - - *467 - - *722 - - *458 + - *469 + - *470 + - *724 + - *461 responses: '204': description: Response @@ -101706,9 +102055,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *466 - - *467 - - *525 + - *469 + - *470 + - *526 - *17 - *19 responses: @@ -101725,7 +102074,7 @@ paths: oneOf: - allOf: - *165 - - &723 + - &725 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -101746,67 +102095,67 @@ paths: description: The ID of the ruleset that includes this rule. - allOf: - *166 - - *723 + - *725 - allOf: - *167 - - *723 + - *725 - allOf: - *168 - - *723 + - *725 - allOf: - - *724 - - *723 + - *726 + - *725 - allOf: - *169 - - *723 + - *725 - allOf: - *170 - - *723 + - *725 - allOf: - *171 - - *723 + - *725 - allOf: - *172 - - *723 + - *725 - allOf: - *173 - - *723 + - *725 - allOf: - *174 - - *723 + - *725 - allOf: - *175 - - *723 + - *725 - allOf: - *176 - - *723 + - *725 - allOf: - *177 - - *723 + - *725 - allOf: - *178 - - *723 + - *725 - allOf: - *179 - - *723 + - *725 - allOf: - *180 - - *723 + - *725 - allOf: - *181 - - *723 + - *725 - allOf: - *182 - - *723 + - *725 - allOf: - *183 - - *723 + - *725 - allOf: - *184 - - *723 + - *725 - allOf: + - *727 - *725 - - *723 examples: default: value: @@ -101845,8 +102194,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - name: includes_parents @@ -101857,7 +102206,7 @@ paths: schema: type: boolean default: true - - *726 + - *728 responses: '200': description: Response @@ -101912,8 +102261,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 requestBody: description: Request body required: true @@ -101942,7 +102291,7 @@ paths: rules: type: array description: An array of rules within the ruleset. - items: *727 + items: *729 required: - name - enforcement @@ -101975,7 +102324,7 @@ paths: application/json: schema: *185 examples: - default: &736 + default: &738 value: id: 42 name: super cool ruleset @@ -102022,12 +102371,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *466 - - *467 - - *728 - - *101 - - *729 + - *469 + - *470 - *730 + - *101 + - *731 + - *732 - *17 - *19 responses: @@ -102035,9 +102384,9 @@ paths: description: Response content: application/json: - schema: *731 + schema: *733 examples: - default: *732 + default: *734 '404': *6 '500': *40 x-github: @@ -102058,17 +102407,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *466 - - *467 - - *733 + - *469 + - *470 + - *735 responses: '200': description: Response content: application/json: - schema: *734 + schema: *736 examples: - default: *735 + default: *737 '404': *6 '500': *40 x-github: @@ -102096,8 +102445,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102119,7 +102468,7 @@ paths: application/json: schema: *185 examples: - default: *736 + default: *738 '404': *6 '500': *40 put: @@ -102137,8 +102486,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102172,7 +102521,7 @@ paths: rules: description: An array of rules within the ruleset. type: array - items: *727 + items: *729 examples: default: value: @@ -102202,7 +102551,7 @@ paths: application/json: schema: *185 examples: - default: *736 + default: *738 '404': *6 '500': *40 delete: @@ -102220,8 +102569,8 @@ paths: category: repos subcategory: rules parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102244,8 +102593,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-history parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 - name: ruleset_id @@ -102263,7 +102612,7 @@ paths: type: array items: *189 examples: - default: *418 + default: *421 '404': *6 '500': *40 x-github: @@ -102282,8 +102631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-repository-ruleset-version parameters: - - *466 - - *467 + - *469 + - *470 - name: ruleset_id description: The ID of the ruleset. in: path @@ -102301,7 +102650,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *422 examples: default: value: @@ -102356,21 +102705,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: - - *466 - - *467 - - *420 - - *421 - - *422 + - *469 + - *470 - *423 - - *106 - - *19 - - *17 - - *737 - - *738 - *424 - *425 - *426 + - *106 + - *19 + - *17 + - *739 + - *740 - *427 + - *428 + - *429 + - *430 responses: '200': description: Response @@ -102378,7 +102727,7 @@ paths: application/json: schema: type: array - items: &742 + items: &744 type: object properties: number: *123 @@ -102397,8 +102746,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *739 - resolution: *740 + state: *741 + resolution: *742 resolved_at: type: string format: date-time @@ -102494,7 +102843,7 @@ paths: pull request. ' - oneOf: *741 + oneOf: *743 nullable: true has_more_locations: type: boolean @@ -102643,16 +102992,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: - - *466 - - *467 - - *554 - - *427 + - *469 + - *470 + - *555 + - *430 responses: '200': description: Response content: application/json: - schema: *742 + schema: *744 examples: default: value: @@ -102704,9 +103053,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 requestBody: required: true content: @@ -102714,15 +103063,16 @@ paths: schema: type: object properties: - state: *739 - resolution: *740 + state: *741 + resolution: *742 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: string nullable: true - required: - - state + anyOf: + - required: + - state examples: default: value: @@ -102733,7 +103083,7 @@ paths: description: Response content: application/json: - schema: *742 + schema: *744 examples: default: value: @@ -102808,9 +103158,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: - - *466 - - *467 - - *554 + - *469 + - *470 + - *555 - *19 - *17 responses: @@ -102821,7 +103171,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &924 + items: &926 type: object properties: type: @@ -102847,8 +103197,6 @@ paths: example: commit details: oneOf: - - *743 - - *744 - *745 - *746 - *747 @@ -102860,6 +103208,8 @@ paths: - *753 - *754 - *755 + - *756 + - *757 examples: default: value: @@ -102945,8 +103295,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -102954,14 +103304,14 @@ paths: schema: type: object properties: - reason: &757 + reason: &759 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *756 + placeholder_id: *758 required: - reason - placeholder_id @@ -102978,7 +103328,7 @@ paths: schema: type: object properties: - reason: *757 + reason: *759 expire_at: type: string format: date-time @@ -103024,8 +103374,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: - - *466 - - *467 + - *469 + - *470 responses: '404': description: Repository does not have GitHub Advanced Security or secret @@ -103040,7 +103390,7 @@ paths: properties: incremental_scans: type: array - items: &758 + items: &760 description: Information on a single scan performed by secret scanning on the repository type: object @@ -103066,15 +103416,15 @@ paths: nullable: true pattern_update_scans: type: array - items: *758 + items: *760 backfill_scans: type: array - items: *758 + items: *760 custom_pattern_backfill_scans: type: array items: allOf: - - *758 + - *760 - type: object properties: pattern_name: @@ -103144,8 +103494,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *466 - - *467 + - *469 + - *470 - *106 - name: sort description: The property to sort the results by. @@ -103189,9 +103539,9 @@ paths: application/json: schema: type: array - items: *759 + items: *761 examples: - default: *760 + default: *762 '400': *14 '404': *6 x-github: @@ -103214,8 +103564,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -103288,7 +103638,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 required: - login - type @@ -103375,9 +103725,9 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: &762 + default: &764 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -103610,8 +103960,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -103715,7 +104065,7 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: default: value: @@ -103862,17 +104212,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '200': description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: *762 + default: *764 '403': *29 '404': *6 x-github: @@ -103896,9 +104246,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 requestBody: required: true content: @@ -103971,7 +104321,7 @@ paths: login: type: string description: The username of the user credited. - type: *432 + type: *435 required: - login - type @@ -104057,17 +104407,17 @@ paths: description: Response content: application/json: - schema: *759 + schema: *761 examples: - default: *762 - add_credit: *762 + default: *764 + add_credit: *764 '403': *29 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *255 + schema: *259 examples: invalid_state_transition: value: @@ -104098,9 +104448,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '202': *39 '400': *14 @@ -104127,17 +104477,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: - - *466 - - *467 - - *761 + - *469 + - *470 + - *763 responses: '202': description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 '400': *14 '422': *15 '403': *29 @@ -104163,8 +104513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -104263,8 +104613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -104273,7 +104623,7 @@ paths: application/json: schema: type: array - items: &763 + items: &765 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -104306,8 +104656,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -104383,8 +104733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -104480,8 +104830,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -104635,8 +104985,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -104646,7 +104996,7 @@ paths: application/json: schema: type: array - items: *763 + items: *765 examples: default: value: @@ -104679,8 +105029,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *466 - - *467 + - *469 + - *470 - name: sha in: path required: true @@ -104734,7 +105084,7 @@ paths: description: Response content: application/json: - schema: *764 + schema: *766 examples: default: value: @@ -104788,8 +105138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -104801,7 +105151,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -104821,14 +105171,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &765 + schema: &767 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -104896,8 +105246,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: false content: @@ -104923,7 +105273,7 @@ paths: description: Response content: application/json: - schema: *765 + schema: *767 examples: default: value: @@ -104950,8 +105300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -104971,8 +105321,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -105051,8 +105401,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: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105060,7 +105410,7 @@ paths: application/json: schema: type: array - items: &766 + items: &768 title: Tag protection description: Tag protection type: object @@ -105112,8 +105462,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: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105136,7 +105486,7 @@ paths: description: Response content: application/json: - schema: *766 + schema: *768 examples: default: value: @@ -105167,8 +105517,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: - - *466 - - *467 + - *469 + - *470 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -105205,8 +105555,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *466 - - *467 + - *469 + - *470 - name: ref in: path required: true @@ -105242,8 +105592,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *466 - - *467 + - *469 + - *470 - *17 - *19 responses: @@ -105253,9 +105603,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - default: *379 + default: *383 headers: Link: *43 '404': *6 @@ -105275,8 +105625,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *466 - - *467 + - *469 + - *470 - *19 - *17 responses: @@ -105284,7 +105634,7 @@ paths: description: Response content: application/json: - schema: &767 + schema: &769 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -105296,7 +105646,7 @@ paths: required: - names examples: - default: &768 + default: &770 value: names: - octocat @@ -105319,8 +105669,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105351,9 +105701,9 @@ paths: description: Response content: application/json: - schema: *767 + schema: *769 examples: - default: *768 + default: *770 '404': *6 '422': *7 x-github: @@ -105374,9 +105724,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *466 - - *467 - - &769 + - *469 + - *470 + - &771 name: per description: The time frame to display results for. in: query @@ -105405,7 +105755,7 @@ paths: example: 128 clones: type: array - items: &770 + items: &772 title: Traffic type: object properties: @@ -105492,8 +105842,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105583,8 +105933,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *466 - - *467 + - *469 + - *470 responses: '200': description: Response @@ -105644,9 +105994,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *466 - - *467 - - *769 + - *469 + - *470 + - *771 responses: '200': description: Response @@ -105665,7 +106015,7 @@ paths: example: 3782 views: type: array - items: *770 + items: *772 required: - uniques - count @@ -105742,8 +106092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *466 - - *467 + - *469 + - *470 requestBody: required: true content: @@ -105779,7 +106129,7 @@ paths: description: Response content: application/json: - schema: *280 + schema: *284 examples: default: value: @@ -106017,8 +106367,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -106041,8 +106391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -106064,8 +106414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -106091,8 +106441,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *466 - - *467 + - *469 + - *470 - name: ref in: path required: true @@ -106184,9 +106534,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -106227,7 +106577,7 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: default: value: @@ -106337,7 +106687,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &778 + - &780 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -106346,7 +106696,7 @@ paths: schema: type: string example: members - - &783 + - &785 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -106357,7 +106707,7 @@ paths: default: 1 format: int32 example: 1 - - &784 + - &786 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -106399,7 +106749,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &773 + items: &775 allOf: - type: object required: @@ -106474,7 +106824,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: &785 + meta: &787 type: object description: The metadata associated with the creation/updates to the user. @@ -106534,30 +106884,30 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &774 + '400': &776 description: Bad request content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '401': *772 - '403': &775 + schema: *773 + '401': *774 + '403': &777 description: Permission denied - '429': &776 + '429': &778 description: Too many requests content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '500': &777 + schema: *773 + '500': &779 description: Internal server error content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 + schema: *773 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106581,7 +106931,7 @@ paths: required: true content: application/json: - schema: &781 + schema: &783 type: object required: - schemas @@ -106641,9 +106991,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *773 + schema: *775 examples: - group: &779 + group: &781 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -106662,13 +107012,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': *774 - '401': *772 - '403': *775 - '409': &782 + '400': *776 + '401': *774 + '403': *777 + '409': &784 description: Duplicate record detected - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106685,7 +107035,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: - - &780 + - &782 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -106693,22 +107043,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *778 + - *780 - *41 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *773 + schema: *775 examples: - default: *779 - '400': *774 - '401': *772 - '403': *775 + default: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106727,13 +107077,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: - - *780 + - *782 - *41 requestBody: required: true content: application/json: - schema: *781 + schema: *783 examples: group: summary: Group @@ -106759,17 +107109,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *773 + schema: *775 examples: - group: *779 - groupWithMembers: *779 - '400': *774 - '401': *772 - '403': *775 + group: *781 + groupWithMembers: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106793,13 +107143,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: - - *780 + - *782 - *41 requestBody: required: true content: application/json: - schema: &792 + schema: &794 type: object required: - Operations @@ -106859,17 +107209,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *773 + schema: *775 examples: - updateGroup: *779 - addMembers: *779 - '400': *774 - '401': *772 - '403': *775 + updateGroup: *781 + addMembers: *781 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106885,17 +107235,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: - - *780 + - *782 - *41 responses: '204': description: Group was deleted, no content - '400': *774 - '401': *772 - '403': *775 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -106929,8 +107279,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *783 - - *784 + - *785 + - *786 - *41 responses: '200': @@ -106963,7 +107313,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &787 + items: &789 allOf: - type: object required: @@ -107042,7 +107392,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &786 + roles: &788 type: array description: The roles assigned to the user. items: @@ -107098,7 +107448,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *785 + meta: *787 startIndex: type: integer description: A starting index for the returned page @@ -107135,11 +107485,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *774 - '401': *772 - '403': *775 - '429': *776 - '500': *777 + '400': *776 + '401': *774 + '403': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107163,7 +107513,7 @@ paths: required: true content: application/json: - schema: &790 + schema: &792 type: object required: - schemas @@ -107245,9 +107595,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *786 + roles: *788 examples: - user: &791 + user: &793 summary: User value: schemas: @@ -107294,9 +107644,9 @@ paths: description: User has been created content: application/scim+json: - schema: *787 + schema: *789 examples: - user: &788 + user: &790 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107322,13 +107672,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: *788 - '400': *774 - '401': *772 - '403': *775 - '409': *782 - '429': *776 - '500': *777 + enterpriseOwner: *790 + '400': *776 + '401': *774 + '403': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107345,7 +107695,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: - - &789 + - &791 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -107358,15 +107708,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *787 + schema: *789 examples: - default: *788 - '400': *774 - '401': *772 - '403': *775 + default: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107388,30 +107738,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: - - *789 + - *791 - *41 requestBody: required: true content: application/json: - schema: *790 + schema: *792 examples: - user: *791 + user: *793 responses: '200': description: User was updated content: application/scim+json: - schema: *787 + schema: *789 examples: - user: *788 - '400': *774 - '401': *772 - '403': *775 + user: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107446,13 +107796,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: - - *789 + - *791 - *41 requestBody: required: true content: application/json: - schema: *792 + schema: *794 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -107492,18 +107842,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *787 + schema: *789 examples: - userMultiValuedProperties: *788 - userSingleValuedProperties: *788 - disableUser: *788 - '400': *774 - '401': *772 - '403': *775 + userMultiValuedProperties: *790 + userSingleValuedProperties: *790 + disableUser: *790 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '409': *782 - '429': *776 - '500': *777 + '409': *784 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107523,17 +107873,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: - - *789 + - *791 - *41 responses: '204': description: User was deleted, no content - '400': *774 - '401': *772 - '403': *775 + '400': *776 + '401': *774 + '403': *777 '404': *6 - '429': *776 - '500': *777 + '429': *778 + '500': *779 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -107620,7 +107970,7 @@ paths: example: 1 Resources: type: array - items: &793 + items: &795 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -107851,22 +108201,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &794 + '404': &796 description: Resource not found content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '403': &795 + schema: *773 + '403': &797 description: Forbidden content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '400': *774 - '429': *776 + schema: *773 + '400': *776 + '429': *778 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -107892,9 +108242,9 @@ paths: description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: &796 + default: &798 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -107917,17 +108267,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *794 - '403': *795 - '500': *777 + '404': *796 + '403': *797 + '500': *779 '409': description: Conflict content: application/json: - schema: *771 + schema: *773 application/scim+json: - schema: *771 - '400': *774 + schema: *773 + '400': *776 requestBody: required: true content: @@ -108025,17 +108375,17 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 - '404': *794 - '403': *795 + default: *798 + '404': *796 + '403': *797 '304': *37 x-github: githubCloudOnly: true @@ -108059,18 +108409,18 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 + default: *798 '304': *37 - '404': *794 - '403': *795 + '404': *796 + '403': *797 requestBody: required: true content: @@ -108183,19 +108533,19 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - *83 - - *789 + - *791 responses: '200': description: Response content: application/scim+json: - schema: *793 + schema: *795 examples: - default: *796 + default: *798 '304': *37 - '404': *794 - '403': *795 - '400': *774 + '404': *796 + '403': *797 + '400': *776 '429': description: Response content: @@ -108286,12 +108636,12 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - *83 - - *789 + - *791 responses: '204': description: Response - '404': *794 - '403': *795 + '404': *796 + '403': *797 '304': *37 x-github: githubCloudOnly: true @@ -108406,7 +108756,7 @@ paths: html_url: type: string format: uri - repository: *280 + repository: *284 score: type: number file_size: @@ -108424,7 +108774,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &797 + text_matches: &799 title: Search Result Text Matches type: array items: @@ -108587,7 +108937,7 @@ paths: enum: - author-date - committer-date - - &798 + - &800 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 @@ -108658,7 +109008,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true comment_count: type: integer @@ -108678,7 +109028,7 @@ paths: url: type: string format: uri - verification: *645 + verification: *646 required: - author - committer @@ -108697,7 +109047,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *523 + properties: *524 nullable: true parents: type: array @@ -108710,12 +109060,12 @@ paths: type: string sha: type: string - repository: *280 + repository: *284 score: type: number node_id: type: string - text_matches: *797 + text_matches: *799 required: - sha - node_id @@ -108908,7 +109258,7 @@ paths: - interactions - created - updated - - *798 + - *800 - *17 - *19 - name: advanced_search @@ -109005,11 +109355,11 @@ paths: description: type: string nullable: true - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: type: string state_reason: @@ -109026,8 +109376,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *401 - required: *402 + properties: *404 + required: *405 nullable: true comments: type: integer @@ -109041,7 +109391,7 @@ paths: type: string format: date-time nullable: true - text_matches: *797 + text_matches: *799 pull_request: type: object properties: @@ -109074,7 +109424,7 @@ paths: type: string score: type: number - author_association: *213 + author_association: *214 draft: type: boolean repository: *74 @@ -109085,7 +109435,7 @@ paths: timeline_url: type: string format: uri - type: *364 + type: *368 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -109095,9 +109445,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 - reactions: *214 + properties: *212 + required: *213 + reactions: *215 required: - assignee - closed_at @@ -109266,7 +109616,7 @@ paths: enum: - created - updated - - *798 + - *800 - *17 - *19 responses: @@ -109310,7 +109660,7 @@ paths: nullable: true score: type: number - text_matches: *797 + text_matches: *799 required: - id - node_id @@ -109396,7 +109746,7 @@ paths: - forks - help-wanted-issues - updated - - *798 + - *800 - *17 - *19 responses: @@ -109615,8 +109965,8 @@ paths: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true permissions: type: object @@ -109635,7 +109985,7 @@ paths: - admin - pull - push - text_matches: *797 + text_matches: *799 temp_clone_token: type: string allow_merge_commit: @@ -109936,7 +110286,7 @@ paths: type: string format: uri nullable: true - text_matches: *797 + text_matches: *799 related: type: array nullable: true @@ -110129,7 +110479,7 @@ paths: - followers - repositories - joined - - *798 + - *800 - *17 - *19 responses: @@ -110233,7 +110583,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *797 + text_matches: *799 blog: type: string nullable: true @@ -110312,7 +110662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &802 + - &804 name: team_id description: The unique identifier of the team. in: path @@ -110324,9 +110674,9 @@ paths: description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 x-github: githubCloudOnly: false @@ -110353,7 +110703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *802 + - *804 requestBody: required: true content: @@ -110416,16 +110766,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '201': description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '404': *6 '422': *15 '403': *29 @@ -110453,7 +110803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *802 + - *804 responses: '204': description: Response @@ -110484,7 +110834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *802 + - *804 - *106 - *17 - *19 @@ -110495,9 +110845,9 @@ paths: application/json: schema: type: array - items: *449 + items: *452 examples: - default: *803 + default: *805 headers: Link: *43 x-github: @@ -110526,7 +110876,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *802 + - *804 requestBody: required: true content: @@ -110560,9 +110910,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: triggersNotification: true githubCloudOnly: false @@ -110589,16 +110939,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 responses: '200': description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110623,8 +110973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 requestBody: required: false content: @@ -110647,9 +110997,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *804 + default: *806 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110674,8 +111024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *802 - - *451 + - *804 + - *454 responses: '204': description: Response @@ -110704,8 +111054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *802 - - *451 + - *804 + - *454 - *106 - *17 - *19 @@ -110716,9 +111066,9 @@ paths: application/json: schema: type: array - items: *452 + items: *455 examples: - default: *805 + default: *807 headers: Link: *43 x-github: @@ -110747,8 +111097,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 + - *454 requestBody: required: true content: @@ -110770,9 +111120,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: triggersNotification: true githubCloudOnly: false @@ -110799,17 +111149,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 responses: '200': description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110834,9 +111184,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 requestBody: required: true content: @@ -110858,9 +111208,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: - default: *806 + default: *808 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -110885,9 +111235,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *802 - - *451 + - *804 - *454 + - *457 responses: '204': description: Response @@ -110916,9 +111266,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: - - *802 - - *451 + - *804 - *454 + - *457 - 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. @@ -110944,9 +111294,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -110975,9 +111325,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: - - *802 - - *451 + - *804 - *454 + - *457 requestBody: required: true content: @@ -111009,9 +111359,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -111037,8 +111387,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: - - *802 - - *451 + - *804 + - *454 - 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. @@ -111064,9 +111414,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *457 + default: *460 headers: Link: *43 x-github: @@ -111095,8 +111445,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: - - *802 - - *451 + - *804 + - *454 requestBody: required: true content: @@ -111128,9 +111478,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -111154,7 +111504,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111164,9 +111514,9 @@ paths: application/json: schema: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: Link: *43 x-github: @@ -111192,7 +111542,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *802 + - *804 - name: role description: Filters members returned by their role in the team. in: query @@ -111215,7 +111565,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '404': *6 @@ -111243,7 +111593,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111280,7 +111630,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111320,7 +111670,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *802 + - *804 - *138 responses: '204': @@ -111357,16 +111707,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: - - *802 + - *804 - *138 responses: '200': description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-user-is-a-team-maintainer: *807 + response-if-user-is-a-team-maintainer: *809 '404': *6 x-github: githubCloudOnly: false @@ -111399,7 +111749,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: - - *802 + - *804 - *138 requestBody: required: false @@ -111425,9 +111775,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: - response-if-users-membership-with-team-is-now-pending: *808 + response-if-users-membership-with-team-is-now-pending: *810 '403': description: Forbidden if team synchronization is set up '422': @@ -111461,7 +111811,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: - - *802 + - *804 - *138 responses: '204': @@ -111490,7 +111840,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111500,9 +111850,9 @@ paths: application/json: schema: type: array - items: *464 + items: *467 examples: - default: *809 + default: *811 headers: Link: *43 '404': *6 @@ -111528,16 +111878,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: - - *802 - - *465 + - *804 + - *468 responses: '200': description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *810 + default: *812 '404': description: Not Found if project is not managed by this team x-github: @@ -111561,8 +111911,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: - - *802 - - *465 + - *804 + - *468 requestBody: required: false content: @@ -111629,8 +111979,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: - - *802 - - *465 + - *804 + - *468 responses: '204': description: Response @@ -111657,7 +112007,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -111667,9 +112017,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '404': *6 @@ -111699,15 +112049,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *811 + schema: *813 examples: alternative-response-with-extra-repository-information: value: @@ -111858,9 +112208,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 requestBody: required: false content: @@ -111910,9 +112260,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: - - *802 - - *466 - - *467 + - *804 + - *469 + - *470 responses: '204': description: Response @@ -111941,15 +112291,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: - - *802 + - *804 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 '403': *29 '404': *6 x-github: @@ -111976,7 +112326,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: - - *802 + - *804 requestBody: required: true content: @@ -112033,7 +112383,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -112064,7 +112414,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *802 + - *804 - *17 - *19 responses: @@ -112074,9 +112424,9 @@ paths: application/json: schema: type: array - items: *307 + items: *311 examples: - response-if-child-teams-exist: *812 + response-if-child-teams-exist: *814 headers: Link: *43 '404': *6 @@ -112109,7 +112459,7 @@ paths: application/json: schema: oneOf: - - &814 + - &816 title: Private User description: Private User type: object @@ -112312,7 +112662,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *813 + - *815 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -112465,7 +112815,7 @@ paths: description: Response content: application/json: - schema: *814 + schema: *816 examples: default: value: @@ -112544,7 +112894,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 '304': *37 '404': *6 '403': *29 @@ -112668,9 +113018,9 @@ paths: type: integer codespaces: type: array - items: *369 + items: *373 examples: - default: *370 + default: *374 '304': *37 '500': *40 '401': *25 @@ -112809,17 +113159,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -112863,7 +113213,7 @@ paths: type: integer secrets: type: array - items: &815 + items: &817 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -112903,7 +113253,7 @@ paths: - visibility - selected_repositories_url examples: - default: *577 + default: *578 headers: Link: *43 x-github: @@ -112973,13 +113323,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: - - *290 + - *294 responses: '200': description: Response content: application/json: - schema: *815 + schema: *817 examples: default: value: @@ -113009,7 +113359,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: - - *290 + - *294 requestBody: required: true content: @@ -113054,7 +113404,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -113082,7 +113432,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: - - *290 + - *294 responses: '204': description: Response @@ -113107,7 +113457,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: - - *290 + - *294 responses: '200': description: Response @@ -113123,9 +113473,9 @@ paths: type: integer repositories: type: array - items: *280 + items: *284 examples: - default: *816 + default: *818 '401': *25 '403': *29 '404': *6 @@ -113150,7 +113500,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: - - *290 + - *294 requestBody: required: true content: @@ -113204,7 +113554,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: - - *290 + - *294 - name: repository_id in: path required: true @@ -113237,7 +113587,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: - - *290 + - *294 - name: repository_id in: path required: true @@ -113269,15 +113619,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '304': *37 '500': *40 '401': *25 @@ -113303,7 +113653,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: - - *371 + - *375 requestBody: required: false content: @@ -113333,9 +113683,9 @@ paths: description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '401': *25 '403': *29 '404': *6 @@ -113357,7 +113707,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: - - *371 + - *375 responses: '202': *39 '304': *37 @@ -113386,13 +113736,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: - - *371 + - *375 responses: '202': description: Response content: application/json: - schema: &817 + schema: &819 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -113433,7 +113783,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &818 + default: &820 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -113465,7 +113815,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *371 + - *375 - name: export_id in: path required: true @@ -113478,9 +113828,9 @@ paths: description: Response content: application/json: - schema: *817 + schema: *819 examples: - default: *818 + default: *820 '404': *6 x-github: githubCloudOnly: false @@ -113501,7 +113851,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *371 + - *375 responses: '200': description: Response @@ -113517,9 +113867,9 @@ paths: type: integer machines: type: array - items: *819 + items: *821 examples: - default: *820 + default: *822 '304': *37 '500': *40 '401': *25 @@ -113548,7 +113898,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: - - *371 + - *375 requestBody: required: true content: @@ -113598,13 +113948,13 @@ paths: nullable: true owner: *4 billable_owner: *4 - repository: *479 + repository: *480 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *575 - required: *576 + properties: *576 + required: *577 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -114378,15 +114728,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '304': *37 '500': *40 '400': *14 @@ -114418,15 +114768,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: - - *371 + - *375 responses: '200': description: Response content: application/json: - schema: *369 + schema: *373 examples: - default: *574 + default: *575 '500': *40 '401': *25 '403': *29 @@ -114456,9 +114806,9 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: &831 + default: &833 value: - id: 197 name: hello_docker @@ -114559,7 +114909,7 @@ paths: application/json: schema: type: array - items: &821 + items: &823 title: Email description: Email type: object @@ -114624,9 +114974,9 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: - default: &833 + default: &835 value: - email: octocat@github.com verified: true @@ -114701,7 +115051,7 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: default: value: @@ -114811,7 +115161,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '304': *37 @@ -114844,7 +115194,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 '304': *37 @@ -114957,7 +115307,7 @@ paths: application/json: schema: type: array - items: &822 + items: &824 title: GPG Key description: A unique encryption key type: object @@ -115088,7 +115438,7 @@ paths: - subkeys - revoked examples: - default: &847 + default: &849 value: - id: 3 name: Octocat's GPG Key @@ -115173,9 +115523,9 @@ paths: description: Response content: application/json: - schema: *822 + schema: *824 examples: - default: &823 + default: &825 value: id: 3 name: Octocat's GPG Key @@ -115232,7 +115582,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: - - &824 + - &826 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -115244,9 +115594,9 @@ paths: description: Response content: application/json: - schema: *822 + schema: *824 examples: - default: *823 + default: *825 '404': *6 '304': *37 '403': *29 @@ -115269,7 +115619,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: - - *824 + - *826 responses: '204': description: Response @@ -115460,7 +115810,7 @@ paths: type: array items: *74 examples: - default: *275 + default: *279 headers: Link: *43 '404': *6 @@ -115485,7 +115835,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *274 + - *278 responses: '204': description: Response @@ -115511,7 +115861,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *274 + - *278 responses: '204': description: Response @@ -115545,12 +115895,12 @@ paths: application/json: schema: anyOf: - - *359 + - *363 - type: object properties: {} additionalProperties: false examples: - default: *360 + default: *364 '204': description: Response when there are no restrictions x-github: @@ -115574,7 +115924,7 @@ paths: required: true content: application/json: - schema: *656 + schema: *657 examples: default: value: @@ -115585,7 +115935,7 @@ paths: description: Response content: application/json: - schema: *359 + schema: *363 examples: default: value: @@ -115666,7 +116016,7 @@ paths: - closed - all default: open - - *367 + - *371 - name: sort description: What to sort results by. in: query @@ -115679,7 +116029,7 @@ paths: - comments default: created - *106 - - *216 + - *217 - *17 - *19 responses: @@ -115689,9 +116039,9 @@ paths: application/json: schema: type: array - items: *226 + items: *227 examples: - default: *368 + default: *372 headers: Link: *43 '404': *6 @@ -115724,7 +116074,7 @@ paths: application/json: schema: type: array - items: &825 + items: &827 title: Key description: Key type: object @@ -115825,9 +116175,9 @@ paths: description: Response content: application/json: - schema: *825 + schema: *827 examples: - default: &826 + default: &828 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -115860,15 +116210,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: - - *685 + - *687 responses: '200': description: Response content: application/json: - schema: *825 + schema: *827 examples: - default: *826 + default: *828 '404': *6 '304': *37 '403': *29 @@ -115891,7 +116241,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: - - *685 + - *687 responses: '204': description: Response @@ -115924,7 +116274,7 @@ paths: application/json: schema: type: array - items: &827 + items: &829 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -115981,7 +116331,7 @@ paths: - id - type - login - plan: *230 + plan: *231 required: - billing_cycle - next_billing_date @@ -115992,7 +116342,7 @@ paths: - account - plan examples: - default: &828 + default: &830 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -116054,9 +116404,9 @@ paths: application/json: schema: type: array - items: *827 + items: *829 examples: - default: *828 + default: *830 headers: Link: *43 '304': *37 @@ -116096,7 +116446,7 @@ paths: application/json: schema: type: array - items: *372 + items: *376 examples: default: value: @@ -116204,7 +116554,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: default: value: @@ -116287,7 +116637,7 @@ paths: description: Response content: application/json: - schema: *372 + schema: *376 examples: default: value: @@ -116355,7 +116705,7 @@ paths: application/json: schema: type: array - items: *374 + items: *378 examples: default: value: @@ -116608,7 +116958,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -116788,7 +117138,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *375 + - *379 - name: exclude in: query required: false @@ -116801,7 +117151,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: default: value: @@ -116995,7 +117345,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *375 + - *379 responses: '302': description: Response @@ -117021,7 +117371,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *375 + - *379 responses: '204': description: Response @@ -117050,8 +117400,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *375 - - *829 + - *379 + - *831 responses: '204': description: Response @@ -117075,7 +117425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *375 + - *379 - *17 - *19 responses: @@ -117085,9 +117435,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '404': *6 @@ -117124,7 +117474,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: *43 '304': *37 @@ -117166,7 +117516,7 @@ paths: - docker - nuget - container - - *830 + - *832 - *19 - *17 responses: @@ -117176,10 +117526,10 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 - '400': *832 + default: *833 + '400': *834 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -117199,16 +117549,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: - - *382 - - *383 + - *386 + - *387 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: - default: &848 + default: &850 value: id: 40201 name: octo-name @@ -117321,8 +117671,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: - - *382 - - *383 + - *386 + - *387 responses: '204': description: Response @@ -117352,8 +117702,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: - - *382 - - *383 + - *386 + - *387 - name: token description: package token schema: @@ -117385,8 +117735,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: - - *382 - - *383 + - *386 + - *387 - *19 - *17 - name: state @@ -117406,7 +117756,7 @@ paths: application/json: schema: type: array - items: *384 + items: *388 examples: default: value: @@ -117455,15 +117805,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '200': description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -117499,9 +117849,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '204': description: Response @@ -117531,9 +117881,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 responses: '204': description: Response @@ -117545,97 +117895,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 - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - 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: *396 - 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': *37 - '403': *29 - '401': *25 - '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 @@ -117661,9 +117920,9 @@ paths: application/json: schema: type: array - items: *821 + items: *823 examples: - default: *833 + default: *835 headers: Link: *43 '304': *37 @@ -117776,7 +118035,7 @@ paths: type: array items: *74 examples: - default: &840 + default: &842 summary: Default response value: - id: 1296269 @@ -118080,9 +118339,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *480 examples: - default: *481 + default: *482 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -118120,9 +118379,9 @@ paths: application/json: schema: type: array - items: *658 + items: *659 examples: - default: *834 + default: *836 headers: Link: *43 '304': *37 @@ -118145,7 +118404,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *363 + - *367 responses: '204': description: Response @@ -118168,7 +118427,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *363 + - *367 responses: '204': description: Response @@ -118201,7 +118460,7 @@ paths: application/json: schema: type: array - items: &835 + items: &837 title: Social account description: Social media account type: object @@ -118216,7 +118475,7 @@ paths: - provider - url examples: - default: &836 + default: &838 value: - provider: twitter url: https://twitter.com/github @@ -118278,9 +118537,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 '422': *15 '304': *37 '404': *6 @@ -118367,7 +118626,7 @@ paths: application/json: schema: type: array - items: &837 + items: &839 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -118387,7 +118646,7 @@ paths: - title - created_at examples: - default: &853 + default: &855 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118453,9 +118712,9 @@ paths: description: Response content: application/json: - schema: *837 + schema: *839 examples: - default: &838 + default: &840 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -118486,7 +118745,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: - - &839 + - &841 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -118498,9 +118757,9 @@ paths: description: Response content: application/json: - schema: *837 + schema: *839 examples: - default: *838 + default: *840 '404': *6 '304': *37 '403': *29 @@ -118523,7 +118782,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: - - *839 + - *841 responses: '204': description: Response @@ -118552,7 +118811,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: - - &854 + - &856 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 @@ -118577,11 +118836,11 @@ paths: type: array items: *74 examples: - default-response: *840 + default-response: *842 application/vnd.github.v3.star+json: schema: type: array - items: &855 + items: &857 title: Starred Repository description: Starred Repository type: object @@ -118737,8 +118996,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response if this repository is starred by you @@ -118766,8 +119025,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -118791,8 +119050,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: - - *466 - - *467 + - *469 + - *470 responses: '204': description: Response @@ -118825,9 +119084,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 '304': *37 @@ -118864,7 +119123,7 @@ paths: application/json: schema: type: array - items: *447 + items: *450 examples: default: value: @@ -118942,7 +119201,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *232 + - *233 responses: '200': description: Response @@ -118950,10 +119209,10 @@ paths: application/json: schema: oneOf: - - *814 - - *813 + - *816 + - *815 examples: - default-response: &842 + default-response: &844 summary: Default response value: login: octocat @@ -118988,7 +119247,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &843 + response-with-git-hub-plan-information: &845 summary: Response with GitHub plan information value: login: octocat @@ -119048,7 +119307,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *841 + - *843 - *17 responses: '200': @@ -119059,7 +119318,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: example: ; rel="next" @@ -119097,11 +119356,11 @@ paths: application/json: schema: oneOf: - - *814 - - *813 + - *816 + - *815 examples: - default-response: *842 - response-with-git-hub-plan-information: *843 + default-response: *844 + response-with-git-hub-plan-information: *845 '404': *6 x-github: githubCloudOnly: false @@ -119151,8 +119410,8 @@ paths: required: - subject_digests examples: - default: *844 - withPredicateType: *845 + default: *846 + withPredicateType: *847 responses: '200': description: Response @@ -119205,7 +119464,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *846 + default: *848 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -119410,12 +119669,12 @@ paths: initiator: type: string examples: - default: *519 + default: *520 '201': description: Response content: application/json: - schema: *291 + schema: *295 examples: default: value: @@ -119449,9 +119708,9 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 + default: *833 '403': *29 '401': *25 x-github: @@ -119484,7 +119743,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119557,7 +119816,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119644,7 +119903,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -119714,7 +119973,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -119745,7 +120004,7 @@ paths: type: array items: *4 examples: - default: *206 + default: *207 headers: Link: *43 x-github: @@ -119792,7 +120051,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - *138 - - *216 + - *217 - *17 - *19 responses: @@ -119802,9 +120061,9 @@ paths: application/json: schema: type: array - items: *217 + items: *218 examples: - default: *218 + default: *219 headers: Link: *43 '422': *15 @@ -119835,9 +120094,9 @@ paths: application/json: schema: type: array - items: *822 + items: *824 examples: - default: *847 + default: *849 headers: Link: *43 x-github: @@ -119941,7 +120200,7 @@ paths: application/json: schema: *22 examples: - default: *655 + default: *656 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120026,7 +120285,7 @@ paths: type: array items: *69 examples: - default: *243 + default: *244 headers: Link: *43 x-github: @@ -120065,7 +120324,7 @@ paths: - docker - nuget - container - - *830 + - *832 - *138 - *19 - *17 @@ -120076,12 +120335,12 @@ paths: application/json: schema: type: array - items: *380 + items: *384 examples: - default: *831 + default: *833 '403': *29 '401': *25 - '400': *832 + '400': *834 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120101,17 +120360,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: - default: *848 + default: *850 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -120132,8 +120391,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 responses: '204': @@ -120166,8 +120425,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - name: token description: package token @@ -120200,8 +120459,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: - - *382 - - *383 + - *386 + - *387 - *138 responses: '200': @@ -120210,7 +120469,7 @@ paths: application/json: schema: type: array - items: *384 + items: *388 examples: default: value: @@ -120268,16 +120527,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: - - *382 - - *383 - - *385 + - *386 + - *387 + - *389 - *138 responses: '200': description: Response content: application/json: - schema: *384 + schema: *388 examples: default: value: @@ -120312,10 +120571,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - - *385 + - *389 responses: '204': description: Response @@ -120347,10 +120606,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *382 - - *383 + - *386 + - *387 - *138 - - *385 + - *389 responses: '204': description: Response @@ -120362,87 +120621,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: - - *138 - - 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: *396 - 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: *43 - '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 @@ -120472,9 +120650,9 @@ paths: application/json: schema: type: array - items: *397 + items: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -120496,16 +120674,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-project-for-user parameters: - - *399 + - *402 - *138 responses: '200': description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 headers: Link: *43 '304': *37 @@ -120527,7 +120705,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#list-project-fields-for-user parameters: - - *399 + - *402 - *138 - *17 - *104 @@ -120539,9 +120717,9 @@ paths: application/json: schema: type: array - items: *400 + items: *403 examples: - default: *849 + default: *851 headers: Link: *43 '304': *37 @@ -120563,17 +120741,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/fields#get-project-field-for-user parameters: - - *399 - - *850 + - *402 + - *852 - *138 responses: '200': description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: *851 + default: *853 headers: Link: *43 '304': *37 @@ -120596,7 +120774,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: - - *399 + - *402 - *138 - *104 - *105 @@ -120629,9 +120807,9 @@ paths: application/json: schema: type: array - items: *406 + items: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -120653,7 +120831,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#add-item-to-user-owned-project parameters: - *138 - - *399 + - *402 requestBody: required: true description: Details of the item to add to the project. @@ -120690,10 +120868,10 @@ paths: description: Response content: application/json: - schema: *852 + schema: *854 examples: - issue: *405 - pull_request: *405 + issue: *408 + pull_request: *408 '304': *37 '403': *29 '401': *25 @@ -120713,9 +120891,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: - - *399 + - *402 - *138 - - *408 + - *411 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -120735,9 +120913,9 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - default: *407 + default: *410 headers: Link: *43 '304': *37 @@ -120758,9 +120936,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#update-project-item-for-user parameters: - - *399 + - *402 - *138 - - *408 + - *411 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -120830,13 +121008,13 @@ paths: description: Response content: application/json: - schema: *406 + schema: *409 examples: - text_field: *407 - number_field: *407 - date_field: *407 - single_select_field: *407 - iteration_field: *407 + text_field: *410 + number_field: *410 + date_field: *410 + single_select_field: *410 + iteration_field: *410 '401': *25 '403': *29 '404': *6 @@ -120856,9 +121034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/items#delete-project-item-for-user parameters: - - *399 + - *402 - *138 - - *408 + - *411 responses: '204': description: Response @@ -120895,7 +121073,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -120970,7 +121148,7 @@ paths: application/json: schema: type: array - items: *238 + items: *239 examples: default: value: @@ -121076,9 +121254,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -121108,9 +121286,9 @@ paths: description: Response content: application/json: - schema: *434 + schema: *437 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121138,9 +121316,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *442 examples: - default: *440 + default: *443 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121161,11 +121339,11 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user parameters: - *138 - - *196 - - *198 - *197 - - *247 - - *200 + - *199 + - *198 + - *251 + - *201 responses: '200': description: Response when getting a billing premium request usage report @@ -121301,9 +121479,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *442 + default: *445 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -121324,9 +121502,9 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-a-user parameters: - *138 - - *196 - - *248 - *197 + - *252 + - *198 responses: '200': description: Response when getting a billing usage report @@ -121405,7 +121583,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. @@ -121418,18 +121596,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: - *138 - - *196 - - *198 - *197 - - *251 - - *200 - - *252 + - *199 + - *198 + - *255 + - *201 + - *256 responses: '200': - description: Response when getting a billing usage summary report + description: Response when getting a billing usage summary content: application/json: schema: @@ -121560,9 +121738,9 @@ paths: application/json: schema: type: array - items: *835 + items: *837 examples: - default: *836 + default: *838 headers: Link: *43 x-github: @@ -121592,9 +121770,9 @@ paths: application/json: schema: type: array - items: *837 + items: *839 examples: - default: *853 + default: *855 headers: Link: *43 x-github: @@ -121619,7 +121797,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - *138 - - *854 + - *856 - *106 - *17 - *19 @@ -121631,11 +121809,11 @@ paths: schema: anyOf: - type: array - items: *855 + items: *857 - type: array items: *74 examples: - default-response: *840 + default-response: *842 headers: Link: *43 x-github: @@ -121664,9 +121842,9 @@ paths: application/json: schema: type: array - items: *280 + items: *284 examples: - default: *386 + default: *390 headers: Link: *43 x-github: @@ -121794,7 +121972,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &856 + enterprise: &858 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -121852,7 +122030,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &857 + installation: &859 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -121871,7 +122049,7 @@ x-webhooks: required: - id - node_id - organization: &858 + organization: &860 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -121931,13 +122109,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &859 + repository: &861 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &896 + properties: &898 id: description: Unique identifier of the repository example: 42 @@ -121957,8 +122135,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *227 - required: *228 + properties: *228 + required: *229 nullable: true organization: title: Simple User @@ -122620,7 +122798,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &897 + required: &899 - archive_url - assignees_url - blobs_url @@ -122771,10 +122949,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -122850,11 +123028,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: &860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: &862 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) @@ -123077,11 +123255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: *860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: *862 sender: *4 required: - action @@ -123264,11 +123442,11 @@ x-webhooks: - everyone required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - rule: *860 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + rule: *862 sender: *4 required: - action @@ -123339,7 +123517,7 @@ x-webhooks: required: true content: application/json: - schema: &863 + schema: &865 title: Exemption request cancellation event type: object properties: @@ -123347,11 +123525,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: &861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: &863 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -123584,7 +123762,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &862 + items: &864 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -123692,7 +123870,7 @@ x-webhooks: required: true content: application/json: - schema: &864 + schema: &866 title: Exemption request completed event type: object properties: @@ -123700,11 +123878,11 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 sender: *4 required: - action @@ -123774,7 +123952,7 @@ x-webhooks: required: true content: application/json: - schema: &865 + schema: &867 title: Exemption request created event type: object properties: @@ -123782,11 +123960,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 sender: *4 required: - action @@ -123856,7 +124034,7 @@ x-webhooks: required: true content: application/json: - schema: &866 + schema: &868 title: Exemption response dismissed event type: object properties: @@ -123864,12 +124042,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 - exemption_response: *862 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 + exemption_response: *864 sender: *4 required: - action @@ -123941,7 +124119,7 @@ x-webhooks: required: true content: application/json: - schema: &867 + schema: &869 title: Exemption response submitted event type: object properties: @@ -123949,12 +124127,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - exemption_request: *861 - exemption_response: *862 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + exemption_request: *863 + exemption_response: *864 sender: *4 required: - action @@ -124027,7 +124205,7 @@ x-webhooks: required: true content: application/json: - schema: *863 + schema: *865 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124094,7 +124272,7 @@ x-webhooks: required: true content: application/json: - schema: *864 + schema: *866 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124161,7 +124339,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124228,7 +124406,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124296,7 +124474,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -124374,7 +124552,7 @@ x-webhooks: type: string enum: - completed - check_run: &869 + check_run: &871 title: CheckRun description: A check performed on the code of a given code change type: object @@ -124427,8 +124605,8 @@ x-webhooks: type: string pull_requests: type: array - items: *536 - repository: *280 + items: *537 + repository: *284 status: example: completed type: string @@ -124465,7 +124643,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *868 + deployment: *870 details_url: example: https://example.com type: string @@ -124515,7 +124693,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *536 + items: *537 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -124550,10 +124728,10 @@ x-webhooks: - output - app - pull_requests - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -124946,11 +125124,11 @@ x-webhooks: type: string enum: - created - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -125346,11 +125524,11 @@ x-webhooks: type: string enum: - requested_action - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 requested_action: description: The action requested by the user. type: object @@ -125755,11 +125933,11 @@ x-webhooks: type: string enum: - rerequested - check_run: *869 - installation: *857 - enterprise: *856 - organization: *858 - repository: *859 + check_run: *871 + installation: *859 + enterprise: *858 + organization: *860 + repository: *861 sender: *4 required: - check_run @@ -126736,10 +126914,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -127409,10 +127587,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -128076,10 +128254,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -128245,7 +128423,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128390,20 +128568,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &870 + commit_oid: &872 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: *856 - installation: *857 - organization: *858 - ref: &871 + enterprise: *858 + installation: *859 + organization: *860 + ref: &873 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: *859 + repository: *861 sender: *4 required: - action @@ -128568,7 +128746,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -128798,12 +128976,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -128898,7 +129076,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129069,12 +129247,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -129240,7 +129418,7 @@ x-webhooks: required: - login - id - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -129406,12 +129584,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -129511,7 +129689,7 @@ x-webhooks: dismissed_by: type: object nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129679,16 +129857,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *859 + repository: *861 sender: *4 required: - action @@ -129785,7 +129963,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *549 + dismissed_comment: *550 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -129925,12 +130103,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *870 - enterprise: *856 - installation: *857 - organization: *858 - ref: *871 - repository: *859 + commit_oid: *872 + enterprise: *858 + installation: *859 + organization: *860 + ref: *873 + repository: *861 sender: *4 required: - action @@ -130187,10 +130365,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -130270,18 +130448,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *858 - pusher_type: &872 + organization: *860 + pusher_type: &874 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &873 + ref: &875 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -130291,7 +130469,7 @@ x-webhooks: enum: - tag - branch - repository: *859 + repository: *861 sender: *4 required: - ref @@ -130374,9 +130552,9 @@ x-webhooks: enum: - created definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130461,9 +130639,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130541,9 +130719,9 @@ x-webhooks: enum: - promote_to_enterprise definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130621,9 +130799,9 @@ x-webhooks: enum: - updated definition: *152 - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -130700,10 +130878,10 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - repository: *859 - organization: *858 + enterprise: *858 + installation: *859 + repository: *861 + organization: *860 sender: *4 new_property_values: type: array @@ -130788,18 +130966,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - pusher_type: *872 - ref: *873 + enterprise: *858 + installation: *859 + organization: *860 + pusher_type: *874 + ref: *875 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *859 + repository: *861 sender: *4 required: - ref @@ -130883,11 +131061,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -130971,11 +131149,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131059,11 +131237,11 @@ x-webhooks: type: string enum: - created - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131145,11 +131323,11 @@ x-webhooks: type: string enum: - dismissed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131231,11 +131409,11 @@ x-webhooks: type: string enum: - fixed - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131318,11 +131496,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131404,11 +131582,11 @@ x-webhooks: type: string enum: - reopened - alert: *605 - installation: *857 - organization: *858 - enterprise: *856 - repository: *859 + alert: *606 + installation: *859 + organization: *860 + enterprise: *858 + repository: *861 sender: *4 required: - action @@ -131485,9 +131663,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - key: &874 + enterprise: *858 + installation: *859 + key: &876 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -131523,8 +131701,8 @@ x-webhooks: - verified - created_at - read_only - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -131601,11 +131779,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - key: *874 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + key: *876 + organization: *860 + repository: *861 sender: *4 required: - action @@ -132166,12 +132344,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: &878 + workflow: &880 title: Workflow type: object nullable: true @@ -132897,13 +133075,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *611 + deployment: *612 pull_requests: type: array - items: *706 - repository: *859 - organization: *858 - installation: *857 + items: *708 + repository: *861 + organization: *860 + installation: *859 sender: *4 responses: '200': @@ -132974,7 +133152,7 @@ x-webhooks: type: string enum: - approved - approver: &875 + approver: &877 type: object properties: avatar_url: @@ -133017,11 +133195,11 @@ x-webhooks: type: string comment: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - reviewers: &876 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + reviewers: &878 type: array items: type: object @@ -133100,7 +133278,7 @@ x-webhooks: sender: *4 since: type: string - workflow_job_run: &877 + workflow_job_run: &879 type: object properties: conclusion: @@ -133831,18 +134009,18 @@ x-webhooks: type: string enum: - rejected - approver: *875 + approver: *877 comment: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - reviewers: *876 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + reviewers: *878 sender: *4 since: type: string - workflow_job_run: *877 + workflow_job_run: *879 workflow_job_runs: type: array items: @@ -134546,13 +134724,13 @@ x-webhooks: type: string enum: - requested - enterprise: *856 + enterprise: *858 environment: type: string - installation: *857 - organization: *858 - repository: *859 - requestor: &883 + installation: *859 + organization: *860 + repository: *861 + requestor: &885 title: User type: object nullable: true @@ -136451,12 +136629,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Deployment Workflow Run type: object @@ -137136,7 +137314,7 @@ x-webhooks: type: string enum: - answered - answer: &881 + answer: &883 type: object properties: author_association: @@ -137293,7 +137471,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &879 + discussion: &881 title: Discussion description: A Discussion in a repository. type: object @@ -137579,7 +137757,7 @@ x-webhooks: - id labels: type: array - items: *668 + items: *670 required: - repository_url - category @@ -137601,10 +137779,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137731,11 +137909,11 @@ x-webhooks: - from required: - category - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137818,11 +137996,11 @@ x-webhooks: type: string enum: - closed - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -137904,7 +138082,7 @@ x-webhooks: type: string enum: - created - comment: &880 + comment: &882 type: object properties: author_association: @@ -138061,11 +138239,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138148,12 +138326,12 @@ x-webhooks: type: string enum: - deleted - comment: *880 - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + comment: *882 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138248,12 +138426,12 @@ x-webhooks: - from required: - body - comment: *880 - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + comment: *882 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138337,11 +138515,11 @@ x-webhooks: type: string enum: - created - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138423,11 +138601,11 @@ x-webhooks: type: string enum: - deleted - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138527,11 +138705,11 @@ x-webhooks: type: string required: - from - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138613,10 +138791,10 @@ x-webhooks: type: string enum: - labeled - discussion: *879 - enterprise: *856 - installation: *857 - label: &882 + discussion: *881 + enterprise: *858 + installation: *859 + label: &884 title: Label type: object properties: @@ -138648,8 +138826,8 @@ x-webhooks: - color - default - description - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138732,11 +138910,11 @@ x-webhooks: type: string enum: - locked - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138818,11 +138996,11 @@ x-webhooks: type: string enum: - pinned - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138904,11 +139082,11 @@ x-webhooks: type: string enum: - reopened - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -138993,16 +139171,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *879 - new_repository: *859 + new_discussion: *881 + new_repository: *861 required: - new_discussion - new_repository - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139085,10 +139263,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *879 - old_answer: *881 - organization: *858 - repository: *859 + discussion: *881 + old_answer: *883 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139170,12 +139348,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *879 - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139258,11 +139436,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139344,11 +139522,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *879 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + discussion: *881 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -139417,7 +139595,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139480,7 +139658,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139546,7 +139724,7 @@ x-webhooks: required: true content: application/json: - schema: *863 + schema: *865 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139612,7 +139790,7 @@ x-webhooks: required: true content: application/json: - schema: *864 + schema: *866 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139678,7 +139856,7 @@ x-webhooks: required: true content: application/json: - schema: *865 + schema: *867 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139744,7 +139922,7 @@ x-webhooks: required: true content: application/json: - schema: *866 + schema: *868 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139810,7 +139988,7 @@ x-webhooks: required: true content: application/json: - schema: *867 + schema: *869 responses: '200': description: Return a 200 status to indicate that the data was received @@ -139877,7 +140055,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *856 + enterprise: *858 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -140537,9 +140715,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - forkee @@ -140685,9 +140863,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pages: description: The pages that were updated. type: array @@ -140724,7 +140902,7 @@ x-webhooks: - action - sha - html_url - repository: *859 + repository: *861 sender: *4 required: - pages @@ -140800,10 +140978,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: &884 + organization: *860 + repositories: &886 description: An array of repository objects that the installation can access. type: array @@ -140829,8 +141007,8 @@ x-webhooks: - name - full_name - private - repository: *859 - requester: *883 + repository: *861 + requester: *885 sender: *4 required: - action @@ -140905,11 +141083,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -140985,11 +141163,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141065,10 +141243,10 @@ x-webhooks: type: string enum: - added - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories_added: &885 + organization: *860 + repositories_added: &887 description: An array of repository objects, which were added to the installation. type: array @@ -141114,15 +141292,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *859 - repository_selection: &886 + repository: *861 + repository_selection: &888 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *883 + requester: *885 sender: *4 required: - action @@ -141201,10 +141379,10 @@ x-webhooks: type: string enum: - removed - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories_added: *885 + organization: *860 + repositories_added: *887 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -141231,9 +141409,9 @@ x-webhooks: - name - full_name - private - repository: *859 - repository_selection: *886 - requester: *883 + repository: *861 + repository_selection: *888 + requester: *885 sender: *4 required: - action @@ -141312,11 +141490,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141495,10 +141673,10 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 target_type: type: string @@ -141577,11 +141755,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *856 + enterprise: *858 installation: *22 - organization: *858 - repositories: *884 - repository: *859 + organization: *860 + repositories: *886 + repository: *861 requester: nullable: true sender: *4 @@ -141705,8 +141883,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *211 - required: *212 + properties: *212 + required: *213 reactions: title: Reactions type: object @@ -141833,8 +142011,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -142628,8 +142806,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142645,7 +142823,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -142978,8 +143156,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -143059,7 +143237,7 @@ x-webhooks: type: string enum: - deleted - comment: &887 + comment: &889 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -143224,8 +143402,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -144015,8 +144193,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144032,7 +144210,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -144367,8 +144545,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -144448,7 +144626,7 @@ x-webhooks: type: string enum: - edited - changes: &916 + changes: &918 description: The changes to the comment. type: object properties: @@ -144460,9 +144638,9 @@ x-webhooks: type: string required: - from - comment: *887 - enterprise: *856 - installation: *857 + comment: *889 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -145255,8 +145433,8 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145272,7 +145450,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -145605,8 +145783,8 @@ x-webhooks: - state - locked - assignee - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145690,15 +145868,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 + blocking_issue: *227 blocking_issue_repo: *74 - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145786,15 +145964,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 + blocking_issue: *227 blocking_issue_repo: *74 - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145881,15 +146059,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 - installation: *857 - organization: *858 - repository: *859 + blocking_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -145977,15 +146155,15 @@ x-webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *226 + blocked_issue: *227 blocked_issue_repo: *74 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *226 - installation: *857 - organization: *858 - repository: *859 + blocking_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -146070,10 +146248,10 @@ x-webhooks: type: string enum: - assigned - assignee: *883 - enterprise: *856 - installation: *857 - issue: &890 + assignee: *885 + enterprise: *858 + installation: *859 + issue: &892 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -146862,11 +147040,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -146882,7 +147060,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -146983,8 +147161,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -147064,8 +147242,8 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -147859,11 +148037,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147879,7 +148057,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -148115,8 +148293,8 @@ x-webhooks: required: - state - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -148195,8 +148373,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -148981,11 +149159,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -149001,7 +149179,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -149101,8 +149279,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -149181,8 +149359,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -149989,11 +150167,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -150009,7 +150187,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -150088,7 +150266,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &888 + milestone: &890 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150226,8 +150404,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -150326,8 +150504,8 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -151116,11 +151294,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -151133,7 +151311,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -151237,9 +151415,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *882 - organization: *858 - repository: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -151319,8 +151497,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -152108,11 +152286,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -152125,7 +152303,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -152229,9 +152407,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *882 - organization: *858 - repository: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -152311,8 +152489,8 @@ x-webhooks: type: string enum: - locked - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -153124,11 +153302,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -153141,7 +153319,7 @@ x-webhooks: timeline_url: type: string format: uri - type: *364 + type: *368 title: description: Title of the issue type: string @@ -153222,8 +153400,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -153302,8 +153480,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -154109,11 +154287,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -154129,7 +154307,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -154207,9 +154385,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *888 - organization: *858 - repository: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -155077,11 +155255,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -155174,7 +155352,7 @@ x-webhooks: required: - login - id - type: *364 + type: *368 required: - id - number @@ -155643,8 +155821,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -156433,11 +156611,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -156453,7 +156631,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -156553,8 +156731,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -156634,9 +156812,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *856 - installation: *857 - issue: &889 + enterprise: *858 + installation: *859 + issue: &891 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -157419,11 +157597,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -157439,7 +157617,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -157539,8 +157717,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -157619,8 +157797,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -158430,11 +158608,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -158528,9 +158706,9 @@ x-webhooks: format: uri user_view_type: type: string - type: *364 - organization: *858 - repository: *859 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -159396,11 +159574,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -159416,7 +159594,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -159984,11 +160162,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *856 - installation: *857 - issue: *889 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *891 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160068,12 +160246,12 @@ x-webhooks: type: string enum: - typed - enterprise: *856 - installation: *857 - issue: *890 - type: *364 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160154,7 +160332,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &919 + assignee: &921 title: User type: object nullable: true @@ -160224,11 +160402,11 @@ x-webhooks: required: - login - id - enterprise: *856 - installation: *857 - issue: *890 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160307,12 +160485,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *856 - installation: *857 - issue: *890 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -160392,8 +160570,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -161203,11 +161381,11 @@ x-webhooks: repository_url: type: string format: uri - sub_issues_summary: *799 - issue_dependencies_summary: *800 + sub_issues_summary: *801 + issue_dependencies_summary: *802 issue_field_values: type: array - items: *801 + items: *803 state: description: State of the issue; either 'open' or 'closed' type: string @@ -161223,7 +161401,7 @@ x-webhooks: title: description: Title of the issue type: string - type: *364 + type: *368 updated_at: type: string format: date-time @@ -161301,8 +161479,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161382,11 +161560,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *856 - installation: *857 - issue: *889 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *891 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161465,12 +161643,12 @@ x-webhooks: type: string enum: - untyped - enterprise: *856 - installation: *857 - issue: *890 - type: *364 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + issue: *892 + type: *368 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161550,11 +161728,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161632,11 +161810,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161746,11 +161924,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - label: *882 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + label: *884 + organization: *860 + repository: *861 sender: *4 required: - action @@ -161832,9 +162010,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: &891 + enterprise: *858 + installation: *859 + marketplace_purchase: &893 title: Marketplace Purchase type: object required: @@ -161917,8 +162095,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *858 - previous_marketplace_purchase: &892 + organization: *860 + previous_marketplace_purchase: &894 title: Marketplace Purchase type: object properties: @@ -161998,7 +162176,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162078,10 +162256,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162164,7 +162342,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162246,10 +162424,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -162331,7 +162509,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *859 + repository: *861 sender: *4 required: - action @@ -162412,8 +162590,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 marketplace_purchase: title: Marketplace Purchase type: object @@ -162495,9 +162673,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *858 - previous_marketplace_purchase: *892 - repository: *859 + organization: *860 + previous_marketplace_purchase: *894 + repository: *861 sender: *4 required: - action @@ -162577,12 +162755,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *856 - installation: *857 - marketplace_purchase: *891 - organization: *858 - previous_marketplace_purchase: *892 - repository: *859 + enterprise: *858 + installation: *859 + marketplace_purchase: *893 + organization: *860 + previous_marketplace_purchase: *894 + repository: *861 sender: *4 required: - action @@ -162684,11 +162862,11 @@ x-webhooks: type: string required: - to - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162788,11 +162966,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162871,11 +163049,11 @@ x-webhooks: type: string enum: - removed - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 sender: *4 required: - action @@ -162953,11 +163131,11 @@ x-webhooks: type: string enum: - added - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163033,7 +163211,7 @@ x-webhooks: required: - login - id - team: &893 + team: &895 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -163256,11 +163434,11 @@ x-webhooks: type: string enum: - removed - enterprise: *856 - installation: *857 - member: *883 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + member: *885 + organization: *860 + repository: *861 scope: description: The scope of the membership. Currently, can only be `team`. @@ -163337,7 +163515,7 @@ x-webhooks: required: - login - id - team: *893 + team: *895 required: - action - scope @@ -163419,8 +163597,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *857 - merge_group: &895 + installation: *859 + merge_group: &897 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -163439,15 +163617,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *894 + head_commit: *896 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163533,10 +163711,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *857 - merge_group: *895 - organization: *858 - repository: *859 + installation: *859 + merge_group: *897 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163609,7 +163787,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 + enterprise: *858 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -163718,16 +163896,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *857 - organization: *858 + installation: *859 + organization: *860 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -163808,11 +163986,11 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -163891,9 +164069,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - milestone: &898 + enterprise: *858 + installation: *859 + milestone: &900 title: Milestone description: A collection of related issues and pull requests. type: object @@ -164030,8 +164208,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164110,11 +164288,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164224,11 +164402,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - milestone: *888 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *890 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164308,11 +164486,11 @@ x-webhooks: type: string enum: - opened - enterprise: *856 - installation: *857 - milestone: *898 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + milestone: *900 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164391,11 +164569,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *883 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + blocked_user: *885 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164474,11 +164652,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *883 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + blocked_user: *885 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -164554,7 +164732,7 @@ x-webhooks: enum: - created definition: *146 - enterprise: *856 + enterprise: *858 sender: *4 required: - action @@ -164634,8 +164812,8 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 sender: *4 required: - action @@ -164708,8 +164886,8 @@ x-webhooks: enum: - updated definition: *146 - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 sender: *4 required: - action @@ -164781,9 +164959,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 new_property_values: type: array @@ -164871,9 +165049,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - membership: &899 + enterprise: *858 + installation: *859 + membership: &901 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -164980,8 +165158,8 @@ x-webhooks: - role - organization_url - user - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165059,11 +165237,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165142,8 +165320,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -165259,10 +165437,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 - user: *883 + user: *885 required: - action - invitation @@ -165340,11 +165518,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165431,11 +165609,11 @@ x-webhooks: properties: from: type: string - enterprise: *856 - installation: *857 - membership: *899 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + membership: *901 + organization: *860 + repository: *861 sender: *4 required: - action @@ -165511,9 +165689,9 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 package: description: Information about the package. type: object @@ -166012,7 +166190,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &900 + items: &902 title: Ruby Gems metadata type: object properties: @@ -166107,7 +166285,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -166183,9 +166361,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 package: description: Information about the package. type: object @@ -166538,7 +166716,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *900 + items: *902 source_url: type: string format: uri @@ -166608,7 +166786,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -166785,12 +166963,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *856 + enterprise: *858 id: type: integer - installation: *857 - organization: *858 - repository: *859 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - id @@ -166867,7 +167045,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &901 + personal_access_token_request: &903 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -167013,10 +167191,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *856 - organization: *858 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167093,11 +167271,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *901 - enterprise: *856 - organization: *858 + personal_access_token_request: *903 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167173,11 +167351,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *901 - enterprise: *856 - organization: *858 + personal_access_token_request: *903 + enterprise: *858 + organization: *860 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167252,11 +167430,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *901 - organization: *858 - enterprise: *856 + personal_access_token_request: *903 + organization: *860 + enterprise: *858 sender: *4 - installation: *857 + installation: *859 required: - action - personal_access_token_request @@ -167361,7 +167539,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *902 + last_response: *904 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -167393,8 +167571,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 zen: description: Random string of GitHub zen. @@ -167639,10 +167817,10 @@ x-webhooks: - from required: - note - enterprise: *856 - installation: *857 - organization: *858 - project_card: &903 + enterprise: *858 + installation: *859 + organization: *860 + project_card: &905 title: Project Card type: object properties: @@ -167761,7 +167939,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -167842,11 +168020,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project_card: *903 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_card: *905 + repository: *861 sender: *4 required: - action @@ -167926,9 +168104,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 project_card: title: Project Card type: object @@ -168056,8 +168234,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -168151,11 +168329,11 @@ x-webhooks: - from required: - note - enterprise: *856 - installation: *857 - organization: *858 - project_card: *903 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_card: *905 + repository: *861 sender: *4 required: - action @@ -168249,9 +168427,9 @@ x-webhooks: - from required: - column_id - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 project_card: allOf: - title: Project Card @@ -168441,7 +168619,7 @@ x-webhooks: type: string required: - after_id - repository: *859 + repository: *861 sender: *4 required: - action @@ -168521,10 +168699,10 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - organization: *858 - project: &905 + enterprise: *858 + installation: *859 + organization: *860 + project: &907 title: Project type: object properties: @@ -168648,7 +168826,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -168728,10 +168906,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project_column: &904 + enterprise: *858 + installation: *859 + organization: *860 + project_column: &906 title: Project Column type: object properties: @@ -168770,7 +168948,7 @@ x-webhooks: - name - created_at - updated_at - repository: *859 + repository: *861 sender: *4 required: - action @@ -168849,18 +169027,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -168950,11 +169128,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 + repository: *861 sender: *4 required: - action @@ -169034,11 +169212,11 @@ x-webhooks: type: string enum: - moved - enterprise: *856 - installation: *857 - organization: *858 - project_column: *904 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project_column: *906 + repository: *861 sender: *4 required: - action @@ -169118,11 +169296,11 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169202,18 +169380,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - project: *905 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *896 - required: *897 + properties: *898 + required: *899 nullable: true sender: *4 required: @@ -169315,11 +169493,11 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169398,11 +169576,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 - organization: *858 - project: *905 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + project: *907 + repository: *861 sender: *4 required: - action @@ -169483,9 +169661,9 @@ x-webhooks: type: string enum: - closed - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169566,9 +169744,9 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169649,9 +169827,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169768,9 +169946,9 @@ x-webhooks: type: string to: type: string - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -169853,7 +170031,7 @@ x-webhooks: type: string enum: - archived - changes: &909 + changes: &911 type: object properties: archived_at: @@ -169867,9 +170045,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *857 - organization: *858 - projects_v2_item: &906 + installation: *859 + organization: *860 + projects_v2_item: &908 title: Projects v2 Item description: An item belonging to a project type: object @@ -169887,7 +170065,7 @@ x-webhooks: type: string description: The node ID of the content represented by this item. - content_type: *404 + content_type: *407 creator: *4 created_at: type: string @@ -170004,9 +170182,9 @@ x-webhooks: nullable: true to: type: string - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170088,9 +170266,9 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170171,9 +170349,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170279,7 +170457,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &907 + - &909 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -170301,7 +170479,7 @@ x-webhooks: required: - id - name - - &908 + - &910 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -170335,8 +170513,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *907 - - *908 + - *909 + - *910 required: - field_value - type: object @@ -170352,9 +170530,9 @@ x-webhooks: nullable: true required: - body - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170449,9 +170627,9 @@ x-webhooks: to: type: string nullable: true - installation: *857 - organization: *858 - projects_v2_item: *906 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170534,10 +170712,10 @@ x-webhooks: type: string enum: - restored - changes: *909 - installation: *857 - organization: *858 - projects_v2_item: *906 + changes: *911 + installation: *859 + organization: *860 + projects_v2_item: *908 sender: *4 required: - action @@ -170619,9 +170797,9 @@ x-webhooks: type: string enum: - reopened - installation: *857 - organization: *858 - projects_v2: *397 + installation: *859 + organization: *860 + projects_v2: *400 sender: *4 required: - action @@ -170702,14 +170880,14 @@ x-webhooks: type: string enum: - created - installation: *857 - organization: *858 - projects_v2_status_update: &912 + installation: *859 + organization: *860 + projects_v2_status_update: &914 title: Projects v2 Status Update description: An status update belonging to a project type: object - properties: *910 - required: *911 + properties: *912 + required: *913 sender: *4 required: - action @@ -170790,9 +170968,9 @@ x-webhooks: type: string enum: - deleted - installation: *857 - organization: *858 - projects_v2_status_update: *912 + installation: *859 + organization: *860 + projects_v2_status_update: *914 sender: *4 required: - action @@ -170928,9 +171106,9 @@ x-webhooks: type: string format: date nullable: true - installation: *857 - organization: *858 - projects_v2_status_update: *912 + installation: *859 + organization: *860 + projects_v2_status_update: *914 sender: *4 required: - action @@ -171001,10 +171179,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - repository @@ -171081,13 +171259,13 @@ x-webhooks: type: string enum: - assigned - assignee: *883 - enterprise: *856 - installation: *857 - number: &913 + assignee: *885 + enterprise: *858 + installation: *859 + number: &915 description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -173370,7 +173548,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -173452,11 +173630,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -175734,7 +175912,7 @@ x-webhooks: - draft reason: type: string - repository: *859 + repository: *861 sender: *4 required: - action @@ -175816,11 +175994,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -178098,7 +178276,7 @@ x-webhooks: - draft reason: type: string - repository: *859 + repository: *861 sender: *4 required: - action @@ -178180,13 +178358,13 @@ x-webhooks: type: string enum: - closed - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: &914 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: &916 allOf: - - *706 + - *708 - type: object properties: allow_auto_merge: @@ -178248,7 +178426,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *859 + repository: *861 sender: *4 required: - action @@ -178329,12 +178507,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -178414,11 +178592,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *856 - milestone: *688 - number: *913 - organization: *858 - pull_request: &915 + enterprise: *858 + milestone: *690 + number: *915 + organization: *860 + pull_request: &917 title: Pull Request type: object properties: @@ -180681,7 +180859,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -180760,11 +180938,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -183046,7 +183224,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *859 + repository: *861 sender: *4 required: - action @@ -183170,12 +183348,12 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -183255,11 +183433,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -185526,7 +185704,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -185606,11 +185784,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *856 - installation: *857 - label: *882 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + label: *884 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -187892,7 +188070,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -187973,10 +188151,10 @@ x-webhooks: type: string enum: - locked - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -190256,7 +190434,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -190336,12 +190514,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *856 - milestone: *688 - number: *913 - organization: *858 - pull_request: *915 - repository: *859 + enterprise: *858 + milestone: *690 + number: *915 + organization: *860 + pull_request: *917 + repository: *861 sender: *4 required: - action @@ -190420,12 +190598,12 @@ x-webhooks: type: string enum: - opened - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190506,12 +190684,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190591,12 +190769,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *856 - installation: *857 - number: *913 - organization: *858 - pull_request: *914 - repository: *859 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 + pull_request: *916 + repository: *861 sender: *4 required: - action @@ -190962,9 +191140,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -193134,7 +193312,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -193214,7 +193392,7 @@ x-webhooks: type: string enum: - deleted - comment: &917 + comment: &919 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. @@ -193499,9 +193677,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -195659,7 +195837,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -195739,11 +195917,11 @@ x-webhooks: type: string enum: - edited - changes: *916 - comment: *917 - enterprise: *856 - installation: *857 - organization: *858 + changes: *918 + comment: *919 + enterprise: *858 + installation: *859 + organization: *860 pull_request: type: object properties: @@ -197904,7 +198082,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *859 + repository: *861 sender: *4 required: - action @@ -197985,9 +198163,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -200160,7 +200338,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 review: description: The review that was affected. type: object @@ -200407,9 +200585,9 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -202463,8 +202641,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 - review: &918 + repository: *861 + review: &920 description: The review that was affected. type: object properties: @@ -202697,12 +202875,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -204985,7 +205163,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_reviewer: title: User type: object @@ -205069,12 +205247,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -207364,7 +207542,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_team: title: Team description: Groups of organization members that gives permissions @@ -207556,12 +207734,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -209846,7 +210024,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_reviewer: title: User type: object @@ -209931,12 +210109,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *856 - installation: *857 + enterprise: *858 + installation: *859 number: description: The pull request number. type: integer - organization: *858 + organization: *860 pull_request: title: Pull Request type: object @@ -212212,7 +212390,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 requested_team: title: Team description: Groups of organization members that gives permissions @@ -212393,9 +212571,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -214570,8 +214748,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 - review: *918 + repository: *861 + review: *920 sender: *4 required: - action @@ -214651,9 +214829,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -216723,7 +216901,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 sender: *4 thread: type: object @@ -217110,9 +217288,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 pull_request: title: Simple Pull Request type: object @@ -219168,7 +219346,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *859 + repository: *861 sender: *4 thread: type: object @@ -219558,10 +219736,10 @@ x-webhooks: type: string before: type: string - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -221832,7 +222010,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -221914,11 +222092,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *919 - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + assignee: *921 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -224201,7 +224379,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -224280,11 +224458,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *856 - installation: *857 - label: *882 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + label: *884 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -226557,7 +226735,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -226638,10 +226816,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *856 - installation: *857 - number: *913 - organization: *858 + enterprise: *858 + installation: *859 + number: *915 + organization: *860 pull_request: title: Pull Request type: object @@ -228906,7 +229084,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *859 + repository: *861 sender: *4 required: - action @@ -229106,7 +229284,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *856 + enterprise: *858 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -229198,8 +229376,8 @@ x-webhooks: - url - author - committer - installation: *857 - organization: *858 + installation: *859 + organization: *860 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -229774,9 +229952,9 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 registry_package: type: object properties: @@ -230222,7 +230400,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *900 + items: *902 summary: type: string tag_name: @@ -230276,7 +230454,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -230354,9 +230532,9 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 registry_package: type: object properties: @@ -230664,7 +230842,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *900 + items: *902 summary: type: string tag_name: @@ -230713,7 +230891,7 @@ x-webhooks: - owner - package_version - registry - repository: *859 + repository: *861 sender: *4 required: - action @@ -230790,10 +230968,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - release: &920 + enterprise: *858 + installation: *859 + organization: *860 + release: &922 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -231111,7 +231289,7 @@ x-webhooks: - updated_at - zipball_url - body - repository: *859 + repository: *861 sender: *4 required: - action @@ -231188,11 +231366,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -231309,11 +231487,11 @@ x-webhooks: type: boolean required: - to - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -231391,9 +231569,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -231715,7 +231893,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *859 + repository: *861 sender: *4 required: - action @@ -231791,10 +231969,10 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - release: &921 + enterprise: *858 + installation: *859 + organization: *860 + release: &923 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -232113,7 +232291,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *859 + repository: *861 sender: *4 required: - action @@ -232189,11 +232367,11 @@ x-webhooks: type: string enum: - released - enterprise: *856 - installation: *857 - organization: *858 - release: *920 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *922 + repository: *861 sender: *4 required: - action @@ -232269,11 +232447,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *856 - installation: *857 - organization: *858 - release: *921 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + release: *923 + repository: *861 sender: *4 required: - action @@ -232349,11 +232527,11 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - repository_advisory: *759 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + repository_advisory: *761 sender: *4 required: - action @@ -232429,11 +232607,11 @@ x-webhooks: type: string enum: - reported - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - repository_advisory: *759 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + repository_advisory: *761 sender: *4 required: - action @@ -232509,10 +232687,10 @@ x-webhooks: type: string enum: - archived - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232589,10 +232767,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232670,10 +232848,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232757,10 +232935,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232872,10 +233050,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -232947,10 +233125,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 status: type: string @@ -233031,10 +233209,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233111,10 +233289,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233208,10 +233386,10 @@ x-webhooks: - name required: - repository - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233291,10 +233469,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 sender: *4 required: @@ -233373,10 +233551,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 sender: *4 required: @@ -233455,10 +233633,10 @@ x-webhooks: type: string enum: - edited - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 repository_ruleset: *185 changes: type: object @@ -233520,16 +233698,16 @@ x-webhooks: properties: added: type: array - items: *727 + items: *729 deleted: type: array - items: *727 + items: *729 updated: type: array items: type: object properties: - rule: *727 + rule: *729 changes: type: object properties: @@ -233763,10 +233941,10 @@ x-webhooks: - from required: - owner - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233844,10 +234022,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -233925,7 +234103,7 @@ x-webhooks: type: string enum: - create - alert: &922 + alert: &924 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -234046,10 +234224,10 @@ x-webhooks: type: string enum: - open - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234255,10 +234433,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234336,11 +234514,11 @@ x-webhooks: type: string enum: - reopen - alert: *922 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *924 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234539,10 +234717,10 @@ x-webhooks: enum: - fixed - open - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234620,7 +234798,7 @@ x-webhooks: type: string enum: - created - alert: &923 + alert: &925 type: object properties: number: *123 @@ -234738,10 +234916,10 @@ x-webhooks: properties: *20 required: *21 nullable: true - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -234822,11 +235000,11 @@ x-webhooks: type: string enum: - created - alert: *923 - installation: *857 - location: *924 - organization: *858 - repository: *859 + alert: *925 + installation: *859 + location: *926 + organization: *860 + repository: *861 sender: *4 required: - location @@ -235064,11 +235242,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235146,11 +235324,11 @@ x-webhooks: type: string enum: - reopened - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235228,11 +235406,11 @@ x-webhooks: type: string enum: - resolved - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235310,11 +235488,11 @@ x-webhooks: type: string enum: - validated - alert: *923 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + alert: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -235440,10 +235618,10 @@ x-webhooks: - organization - enterprise nullable: true - repository: *859 - enterprise: *856 - installation: *857 - organization: *858 + repository: *861 + enterprise: *858 + installation: *859 + organization: *860 sender: *4 required: - action @@ -235521,11 +235699,11 @@ x-webhooks: type: string enum: - published - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - security_advisory: &925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + security_advisory: &927 description: The details of the security advisory, including summary, description, and severity. type: object @@ -235708,11 +235886,11 @@ x-webhooks: type: string enum: - updated - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 - security_advisory: *925 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 + security_advisory: *927 sender: *4 required: - action @@ -235785,10 +235963,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -235972,11 +236150,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *412 - enterprise: *856 - installation: *857 - organization: *858 - repository: *479 + security_and_analysis: *415 + enterprise: *858 + installation: *859 + organization: *860 + repository: *480 sender: *4 required: - changes @@ -236054,12 +236232,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: &926 + sponsorship: &928 type: object properties: created_at: @@ -236360,12 +236538,12 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - sponsorship @@ -236453,12 +236631,12 @@ x-webhooks: type: string required: - from - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236535,17 +236713,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &927 + effective_date: &929 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: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - sponsorship @@ -236619,7 +236797,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &928 + changes: &930 type: object properties: tier: @@ -236663,13 +236841,13 @@ x-webhooks: - from required: - tier - effective_date: *927 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + effective_date: *929 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236746,13 +236924,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *928 - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + changes: *930 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - sponsorship: *926 + sponsorship: *928 required: - action - changes @@ -236826,10 +237004,10 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -236912,10 +237090,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -237335,15 +237513,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *856 + enterprise: *858 id: description: The unique identifier of the status. type: integer - installation: *857 + installation: *859 name: type: string - organization: *858 - repository: *859 + organization: *860 + repository: *861 sender: *4 sha: description: The Commit SHA. @@ -237452,15 +237630,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 + parent_issue: *227 parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 - installation: *857 - organization: *858 - repository: *859 + sub_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237544,15 +237722,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 + parent_issue: *227 parent_issue_repo: *74 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 - installation: *857 - organization: *858 - repository: *859 + sub_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237636,15 +237814,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 + sub_issue: *227 sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 - installation: *857 - organization: *858 - repository: *859 + parent_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237728,15 +237906,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *226 + sub_issue: *227 sub_issue_repo: *74 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *226 - installation: *857 - organization: *858 - repository: *859 + parent_issue: *227 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -237813,12 +237991,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - team: &929 + team: &931 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -238041,9 +238219,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -238501,7 +238679,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -238577,9 +238755,9 @@ x-webhooks: type: string enum: - created - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -239037,7 +239215,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -239114,9 +239292,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -239574,7 +239752,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -239718,9 +239896,9 @@ x-webhooks: - from required: - permissions - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -240178,7 +240356,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - changes @@ -240256,9 +240434,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *856 - installation: *857 - organization: *858 + enterprise: *858 + installation: *859 + organization: *860 repository: title: Repository description: A git repository @@ -240716,7 +240894,7 @@ x-webhooks: - topics - visibility sender: *4 - team: *929 + team: *931 required: - action - team @@ -240792,10 +240970,10 @@ x-webhooks: type: string enum: - started - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 required: - action @@ -240868,16 +241046,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *856 + enterprise: *858 inputs: type: object nullable: true additionalProperties: true - installation: *857 - organization: *858 + installation: *859 + organization: *860 ref: type: string - repository: *859 + repository: *861 sender: *4 workflow: type: string @@ -240959,10 +241137,10 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: allOf: @@ -241199,7 +241377,7 @@ x-webhooks: type: string required: - conclusion - deployment: *611 + deployment: *612 required: - action - repository @@ -241278,10 +241456,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: allOf: @@ -241541,7 +241719,7 @@ x-webhooks: required: - status - steps - deployment: *611 + deployment: *612 required: - action - repository @@ -241620,10 +241798,10 @@ x-webhooks: type: string enum: - queued - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: type: object @@ -241758,7 +241936,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *611 + deployment: *612 required: - action - repository @@ -241837,10 +242015,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 workflow_job: type: object @@ -241976,7 +242154,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *611 + deployment: *612 required: - action - repository @@ -242056,12 +242234,12 @@ x-webhooks: type: string enum: - completed - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object @@ -243060,12 +243238,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object @@ -244049,12 +244227,12 @@ x-webhooks: type: string enum: - requested - enterprise: *856 - installation: *857 - organization: *858 - repository: *859 + enterprise: *858 + installation: *859 + organization: *860 + repository: *861 sender: *4 - workflow: *878 + workflow: *880 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 8d81e376c..695e8703a 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -11934,6 +11934,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", @@ -12719,7 +13230,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" @@ -12727,7 +13238,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": [ { @@ -17357,6 +17868,385 @@ } } }, + "/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", + "example": "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", @@ -17473,7 +18363,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" @@ -17481,7 +18371,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": [ { @@ -34622,172 +35512,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", @@ -42246,261 +42970,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "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", @@ -69898,142 +70367,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": [ { @@ -70043,78 +70386,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": { @@ -75117,8 +75402,12 @@ "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" } }, - "required": [ - "state" + "anyOf": [ + { + "required": [ + "state" + ] + } ] }, "examples": { @@ -86882,185 +87171,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": [ { @@ -87070,12 +87191,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" @@ -87095,92 +87248,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", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - } - }, - "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": { @@ -90376,83 +90577,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", @@ -91655,7 +91779,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" @@ -91663,7 +91787,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": [ { @@ -129137,6 +129261,363 @@ "repositories" ] }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier for the budget", + "example": "2066deda-923f-43f9-88d2-62395a28c0cdd" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "SkuPricing", + "enum": [ + "SkuPricing", + "ProductPricing" + ] + }, + "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", + "example": true + }, + "budget_scope": { + "type": "string", + "description": "The scope of the budget (enterprise, organization, repository, cost center)", + "example": "enterprise" + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity for the budget (enterprise does not require a name).", + "example": "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", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "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", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "number", + "format": "float", + "description": "The budget amount in dollars", + "example": 100.0, + "minimum": 0.0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "type": "string", + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "enum": [ + "ProductPricing", + "SkuPricing" + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "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": { @@ -137373,103 +137854,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", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/nullable-simple-user" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "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" - ] - }, "nullable-projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", @@ -304709,6 +305093,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": [ @@ -310414,82 +310886,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, @@ -313549,42 +313945,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", @@ -323895,44 +324255,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", @@ -331202,42 +331524,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": [ @@ -331919,44 +332205,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": [ { @@ -334387,6 +334635,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", @@ -336284,6 +336541,51 @@ } } }, + "get_all_budgets": { + "description": "Response when getting all budgets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/get_all_budgets" + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}