diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 844b5d6ff0..ce994fb4c2 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -2177,6 +2177,93 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -2449,6 +2536,96 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -11817,6 +11994,93 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -19047,6 +19311,96 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", @@ -94438,6 +94792,334 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, "copilot-usage-metrics": { "title": "Copilot Usage Metrics", "description": "Summary of Copilot usage.", @@ -271792,6 +272474,161 @@ ] } }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-enterprise": { "value": [ { @@ -299707,6 +300544,15 @@ "default": false } }, + "enterprise-team-slug": { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -301021,6 +301867,16 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "service_unavailable": { "description": "Service unavailable", "content": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index a31b0bac0b..8f4e76c422 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -1508,6 +1508,77 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -1694,6 +1765,81 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -8635,6 +8781,80 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -13843,6 +14063,81 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -68298,6 +68593,295 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -200252,6 +200836,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -224375,6 +225058,13 @@ components: schema: type: boolean default: false + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -225470,6 +226160,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 844b5d6ff0..ce994fb4c2 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -2177,6 +2177,93 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -2449,6 +2536,96 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -11817,6 +11994,93 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -19047,6 +19311,96 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", @@ -94438,6 +94792,334 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, "copilot-usage-metrics": { "title": "Copilot Usage Metrics", "description": "Summary of Copilot usage.", @@ -271792,6 +272474,161 @@ ] } }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-enterprise": { "value": [ { @@ -299707,6 +300544,15 @@ "default": false } }, + "enterprise-team-slug": { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -301021,6 +301867,16 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "service_unavailable": { "description": "Service unavailable", "content": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index a31b0bac0b..8f4e76c422 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -1508,6 +1508,77 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -1694,6 +1765,81 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -8635,6 +8781,80 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -13843,6 +14063,81 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -68298,6 +68593,295 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -200252,6 +200836,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -224375,6 +225058,13 @@ components: schema: type: boolean default: false + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -225470,6 +226160,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index a954fb3ee9..50acd0c1f4 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -18689,6 +18689,662 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -22444,6 +23100,671 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -80321,6 +81642,662 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -144110,6 +146087,671 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 70df391d9c..a6a9b7265f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -888,7 +888,7 @@ paths: - subscriptions_url - type - url - type: &211 + type: &214 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1021,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &90 + schema: &93 title: Validation Error Simple description: Validation Error Simple type: object @@ -1054,7 +1054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &512 + - &515 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1585,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &147 + - &150 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 @@ -1606,7 +1606,7 @@ paths: application/json: schema: type: array - items: &148 + items: &151 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1699,7 +1699,7 @@ paths: - installation_id - repository_id examples: - default: &149 + default: &152 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1762,7 +1762,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &89 + schema: &92 title: Validation Error description: Validation Error type: object @@ -1834,7 +1834,7 @@ paths: description: Response content: application/json: - schema: &150 + schema: &153 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1969,7 +1969,7 @@ paths: - request - response examples: - default: &151 + default: &154 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2029,7 +2029,7 @@ paths: parameters: - *16 responses: - '202': &91 + '202': &94 description: Accepted content: application/json: @@ -2238,7 +2238,7 @@ paths: parameters: - *17 - *18 - - &59 + - &62 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) @@ -2975,7 +2975,7 @@ paths: - selected repositories: type: array - items: &54 + items: &57 title: Repository description: A repository on GitHub. type: object @@ -3002,7 +3002,7 @@ paths: license: anyOf: - type: 'null' - - &70 + - &73 title: License Simple description: License Simple type: object @@ -7280,7 +7280,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &130 + items: &133 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -7290,7 +7290,7 @@ paths: organization: anyOf: - type: 'null' - - &85 + - &88 title: Organization Simple description: A GitHub organization. type: object @@ -7365,7 +7365,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &158 + - &161 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -7424,7 +7424,7 @@ paths: parent: anyOf: - type: 'null' - - &172 + - &175 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -7618,7 +7618,7 @@ paths: - created_at additionalProperties: false examples: - default: &131 + default: &134 value: total_seats: 2 seats: @@ -7700,6 +7700,487 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - *38 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &52 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true + examples: + default: &53 + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + '500': *39 + '403': *27 + '404': *6 + '422': &54 + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: *3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -7757,7 +8238,7 @@ paths: application/json: schema: type: array - items: &52 + items: &55 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7937,7 +8418,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &133 + - &136 name: state in: query description: |- @@ -7946,7 +8427,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &134 + - &137 name: severity in: query description: |- @@ -7955,7 +8436,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &135 + - &138 name: ecosystem in: query description: |- @@ -7964,14 +8445,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &136 + - &139 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 - - &137 + - &140 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7981,7 +8462,7 @@ paths: enum: - development - runtime - - &138 + - &141 name: sort in: query description: |- @@ -7997,7 +8478,7 @@ paths: - *40 - *41 - *42 - - &139 + - &142 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8010,7 +8491,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &140 + - &143 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8030,7 +8511,7 @@ paths: application/json: schema: type: array - items: &141 + items: &144 type: object description: A Dependabot alert. properties: @@ -8085,7 +8566,7 @@ paths: - development - runtime - - security_advisory: &368 + security_advisory: &371 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8313,7 +8794,7 @@ paths: 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &120 + dismissed_at: &123 type: - string - 'null' @@ -8344,7 +8825,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &119 + fixed_at: &122 type: - string - 'null' @@ -8352,7 +8833,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &369 + auto_dismissed_at: &372 type: - string - 'null' @@ -8700,7 +9181,7 @@ paths: - repository additionalProperties: false examples: - default: &142 + default: &145 value: - number: 2 state: dismissed @@ -9044,7 +9525,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &202 + - &205 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9055,7 +9536,7 @@ paths: enum: - open - resolved - - &203 + - &206 name: secret_type in: query description: |- @@ -9065,7 +9546,7 @@ paths: required: false schema: type: string - - &204 + - &207 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9074,7 +9555,7 @@ paths: required: false schema: type: string - - &205 + - &208 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. @@ -9090,7 +9571,7 @@ paths: - *17 - *41 - *42 - - &206 + - &209 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9099,7 +9580,7 @@ paths: required: false schema: type: string - - &207 + - &210 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9108,7 +9589,7 @@ paths: schema: type: boolean default: false - - &208 + - &211 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9124,7 +9605,7 @@ paths: application/json: schema: type: array - items: &209 + items: &212 type: object properties: number: *46 @@ -9140,14 +9621,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &505 + state: &508 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: &506 + resolution: &509 type: - string - 'null' @@ -9224,7 +9705,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &210 + default: &213 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9433,7 +9914,7 @@ paths: headers: Link: *37 '404': *6 - '503': &57 + '503': &60 description: Service unavailable content: application/json: @@ -9451,6 +9932,80 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - *38 + - name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -9480,7 +10035,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &169 + - &172 name: team_slug description: The slug of the team name. in: path @@ -9518,9 +10073,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: &132 + default: &135 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -9615,7 +10170,7 @@ paths: application/json: schema: type: array - items: &80 + items: &83 title: Event description: Event type: object @@ -9626,7 +10181,7 @@ paths: type: - string - 'null' - actor: &53 + actor: &56 title: Actor description: Actor type: object @@ -9667,13 +10222,13 @@ paths: - id - name - url - org: *53 + org: *56 payload: type: object properties: action: type: string - issue: &69 + issue: &72 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -9793,7 +10348,7 @@ paths: milestone: anyOf: - type: 'null' - - &356 + - &359 title: Milestone description: A collection of related issues and pull requests. @@ -9965,12 +10520,12 @@ paths: timeline_url: type: string format: uri - repository: *54 + repository: *57 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &55 + author_association: &58 title: author_association type: string description: How the author is associated with the repository. @@ -9985,7 +10540,7 @@ paths: - OWNER examples: - OWNER - reactions: &56 + reactions: &59 title: Reaction Rollup type: object properties: @@ -10043,7 +10598,7 @@ paths: - author_association - created_at - updated_at - comment: &415 + comment: &418 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10093,12 +10648,12 @@ paths: issue_url: type: string format: uri - author_association: *55 + author_association: *58 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - id - node_id @@ -10195,7 +10750,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10285,7 +10840,7 @@ paths: _links: type: object properties: - timeline: &58 + timeline: &61 title: Link With Type description: Hypermedia Link with Type type: object @@ -10297,17 +10852,17 @@ paths: required: - href - type - user: *58 - security_advisories: *58 - current_user: *58 - current_user_public: *58 - current_user_actor: *58 - current_user_organization: *58 + user: *61 + security_advisories: *61 + current_user: *61 + current_user_public: *61 + current_user_actor: *61 + current_user_organization: *61 current_user_organizations: type: array - items: *58 - repository_discussions: *58 - repository_discussions_category: *58 + items: *61 + repository_discussions: *61 + repository_discussions_category: *61 required: - timeline - user @@ -10369,7 +10924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *59 + - *62 - *17 - *18 responses: @@ -10379,7 +10934,7 @@ paths: application/json: schema: type: array - items: &60 + items: &63 title: Base Gist description: Base Gist type: object @@ -10469,7 +11024,7 @@ paths: - created_at - updated_at examples: - default: &61 + default: &64 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10593,7 +11148,7 @@ paths: description: Response content: application/json: - schema: &62 + schema: &65 title: Gist Simple description: Gist Simple type: object @@ -10611,7 +11166,7 @@ paths: url: type: string format: uri - user: &535 + user: &538 title: Public User description: Public User type: object @@ -10976,7 +11531,7 @@ paths: truncated: type: boolean examples: - default: &63 + default: &66 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11078,7 +11633,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *59 + - *62 - *17 - *18 responses: @@ -11088,9 +11643,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '422': *15 @@ -11112,7 +11667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *59 + - *62 - *17 - *18 responses: @@ -11122,9 +11677,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '401': *23 @@ -11152,7 +11707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &64 + - &67 name: gist_id description: The unique identifier of the gist. in: path @@ -11164,10 +11719,10 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - default: *63 - '403': &67 + default: *66 + '403': &70 description: Forbidden Gist content: application/json: @@ -11216,7 +11771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *64 + - *67 requestBody: required: true content: @@ -11280,9 +11835,9 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - updateGist: *63 + updateGist: *66 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -11440,7 +11995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -11469,7 +12024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11479,7 +12034,7 @@ paths: application/json: schema: type: array - items: &65 + items: &68 title: Gist Comment description: A comment made to a gist. type: object @@ -11517,7 +12072,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *55 + author_association: *58 required: - url - id @@ -11582,7 +12137,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *64 + - *67 requestBody: required: true content: @@ -11608,9 +12163,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: &66 + default: &69 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11668,8 +12223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *64 - - &68 + - *67 + - &71 name: comment_id description: The unique identifier of the comment. in: path @@ -11682,12 +12237,12 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '304': *35 '404': *6 - '403': *67 + '403': *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11709,8 +12264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *64 - - *68 + - *67 + - *71 requestBody: required: true content: @@ -11736,9 +12291,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '404': *6 x-github: githubCloudOnly: false @@ -11755,8 +12310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *64 - - *68 + - *67 + - *71 responses: '204': description: Response @@ -11779,7 +12334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11880,7 +12435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11890,7 +12445,7 @@ paths: application/json: schema: type: array - items: *62 + items: *65 examples: default: value: @@ -11955,13 +12510,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *64 + - *67 responses: '201': description: Response content: application/json: - schema: *60 + schema: *63 examples: default: value: @@ -12032,7 +12587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *64 + - *67 responses: '204': description: Response if gist is starred @@ -12062,7 +12617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -12084,7 +12639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -12113,7 +12668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *64 + - *67 - name: sha in: path required: true @@ -12124,9 +12679,9 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - default: *63 + default: *66 '422': *15 '404': *6 '403': *27 @@ -12287,7 +12842,7 @@ paths: type: integer repositories: type: array - items: *54 + items: *57 repository_selection: type: string examples: @@ -12495,7 +13050,7 @@ paths: - closed - all default: open - - &159 + - &162 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12514,7 +13069,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - name: collab in: query required: false @@ -12544,9 +13099,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: &160 + default: &163 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12826,7 +13381,7 @@ paths: application/json: schema: type: array - items: *70 + items: *73 examples: default: value: @@ -13123,7 +13678,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &71 + X-CommonMarker-Version: &74 example: 0.17.4 schema: type: string @@ -13178,7 +13733,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *71 + X-CommonMarker-Version: *74 content: text/html: schema: @@ -13207,7 +13762,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &74 + - &77 name: account_id description: account_id parameter in: path @@ -13219,7 +13774,7 @@ paths: description: Response content: application/json: - schema: &73 + schema: &76 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13253,7 +13808,7 @@ paths: - 'null' id: type: integer - plan: &72 + plan: &75 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13356,7 +13911,7 @@ paths: - 'null' updated_at: type: string - plan: *72 + plan: *75 required: - url - id @@ -13364,7 +13919,7 @@ paths: - login - marketplace_purchase examples: - default: &75 + default: &78 value: url: https://api.github.com/orgs/github type: Organization @@ -13449,9 +14004,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: &76 + default: &79 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -13491,14 +14046,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &77 + - &80 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &78 + - &81 name: sort description: The property to sort the results by. in: query @@ -13528,9 +14083,9 @@ paths: application/json: schema: type: array - items: *73 + items: *76 examples: - default: &79 + default: &82 value: - url: https://api.github.com/orgs/github type: Organization @@ -13604,15 +14159,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *74 + - *77 responses: '200': description: Response content: application/json: - schema: *73 + schema: *76 examples: - default: *75 + default: *78 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -13644,9 +14199,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *76 + default: *79 headers: Link: *37 '401': *23 @@ -13669,8 +14224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *77 - - *78 + - *80 + - *81 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13690,9 +14245,9 @@ paths: application/json: schema: type: array - items: *73 + items: *76 examples: - default: *79 + default: *82 headers: Link: *37 '401': *23 @@ -13942,14 +14497,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &227 + - &230 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &228 + - &231 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -13966,7 +14521,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -14020,7 +14575,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &239 + '301': &242 description: Moved permanently content: application/json: @@ -14042,7 +14597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &443 + - &446 name: all description: If `true`, show notifications marked as read. in: query @@ -14050,7 +14605,7 @@ paths: schema: type: boolean default: false - - &444 + - &447 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14059,8 +14614,8 @@ paths: schema: type: boolean default: false - - *59 - - &445 + - *62 + - &448 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: @@ -14085,14 +14640,14 @@ paths: application/json: schema: type: array - items: &81 + items: &84 title: Thread description: Thread type: object properties: id: type: string - repository: &105 + repository: &108 title: Minimal Repository description: Minimal Repository type: object @@ -14431,7 +14986,7 @@ paths: type: boolean examples: - false - security_and_analysis: &193 + security_and_analysis: &196 type: - object - 'null' @@ -14578,7 +15133,7 @@ paths: - url - subscription_url examples: - default: &446 + default: &449 value: - id: '1' repository: @@ -14744,7 +15299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &82 + - &85 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 @@ -14758,7 +15313,7 @@ paths: description: Response content: application/json: - schema: *81 + schema: *84 examples: default: value: @@ -14860,7 +15415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *82 + - *85 responses: '205': description: Reset Content @@ -14882,7 +15437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *82 + - *85 responses: '204': description: No content @@ -14905,13 +15460,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *82 + - *85 responses: '200': description: Response content: application/json: - schema: &83 + schema: &86 title: Thread Subscription description: Thread Subscription type: object @@ -14955,7 +15510,7 @@ paths: - url - subscribed examples: - default: &84 + default: &87 value: subscribed: true ignored: false @@ -14986,7 +15541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *82 + - *85 requestBody: required: false content: @@ -15007,9 +15562,9 @@ paths: description: Response content: application/json: - schema: *83 + schema: *86 examples: - default: *84 + default: *87 '304': *35 '403': *27 '401': *23 @@ -15032,7 +15587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *82 + - *85 responses: '204': description: Response @@ -15127,9 +15682,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: &552 + default: &555 value: - login: github id: 1 @@ -15174,7 +15729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - &86 + - &89 name: org description: The organization name. The name is not case sensitive. in: path @@ -15186,7 +15741,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &90 title: Organization Full description: Organization Full type: object @@ -15535,7 +16090,7 @@ paths: - updated_at - archived_at examples: - default-response: &88 + default-response: &91 value: login: github id: 1 @@ -15625,7 +16180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *86 + - *89 requestBody: required: false content: @@ -15838,18 +16393,18 @@ paths: description: Response content: application/json: - schema: *87 + schema: *90 examples: - default: *88 + default: *91 '422': description: Validation failed content: application/json: schema: oneOf: - - *89 - - *90 - '409': &125 + - *92 + - *93 + '409': &128 description: Conflict content: application/json: @@ -15876,9 +16431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *86 + - *89 responses: - '202': *91 + '202': *94 '404': *6 '403': *27 x-github: @@ -15901,7 +16456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -15948,7 +16503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -15966,7 +16521,7 @@ paths: type: integer repository_cache_usages: type: array - items: &244 + items: &247 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16024,13 +16579,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *86 + - *89 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &92 + schema: &95 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16044,7 +16599,7 @@ paths: required: - include_claim_keys examples: - default: &93 + default: &96 value: include_claim_keys: - repo @@ -16066,20 +16621,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 responses: '201': description: Empty response content: application/json: - schema: &114 + schema: &117 title: Empty Object description: An object without any properties. type: object @@ -16109,7 +16664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -16118,7 +16673,7 @@ paths: schema: type: object properties: - enabled_repositories: &94 + enabled_repositories: &97 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16131,7 +16686,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: &95 + allowed_actions: &98 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16139,7 +16694,7 @@ paths: - all - local_only - selected - selected_actions_url: &250 + selected_actions_url: &253 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -16170,7 +16725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16181,8 +16736,8 @@ paths: schema: type: object properties: - enabled_repositories: *94 - allowed_actions: *95 + enabled_repositories: *97 + allowed_actions: *98 required: - enabled_repositories examples: @@ -16209,7 +16764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -16227,9 +16782,9 @@ paths: type: number repositories: type: array - items: *54 + items: *57 examples: - default: &546 + default: &549 value: total_count: 1 repositories: @@ -16369,7 +16924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16413,8 +16968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *86 - - &96 + - *89 + - &99 name: repository_id description: The unique identifier of the repository. in: path @@ -16442,8 +16997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *86 - - *96 + - *89 + - *99 responses: '204': description: Response @@ -16466,13 +17021,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &97 + schema: &100 type: object properties: github_owned_allowed: @@ -16494,7 +17049,7 @@ paths: items: type: string examples: - default: &98 + default: &101 value: github_owned_allowed: true verified_allowed: false @@ -16519,7 +17074,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16527,9 +17082,9 @@ paths: required: false content: application/json: - schema: *97 + schema: *100 examples: - selected_actions: *98 + selected_actions: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16551,23 +17106,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &254 + schema: &257 type: object properties: - default_workflow_permissions: &99 + default_workflow_permissions: &102 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &100 + can_approve_pull_request_reviews: &103 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -16575,7 +17130,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &101 + default: &104 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -16600,7 +17155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Success response @@ -16608,13 +17163,13 @@ paths: required: false content: application/json: - schema: &255 + schema: &258 type: object properties: - default_workflow_permissions: *99 - can_approve_pull_request_reviews: *100 + default_workflow_permissions: *102 + can_approve_pull_request_reviews: *103 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16634,7 +17189,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *86 + - *89 - *17 - *18 - name: visible_to_repository @@ -16659,7 +17214,7 @@ paths: type: number runner_groups: type: array - items: &102 + items: &105 type: object properties: id: @@ -16772,7 +17327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -16842,9 +17397,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: &104 + default: &107 value: id: 2 name: octo-runner-group @@ -16879,8 +17434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *86 - - &103 + - *89 + - &106 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -16892,7 +17447,7 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: default: value: @@ -16928,8 +17483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -16980,9 +17535,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *104 + default: *107 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17001,8 +17556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *86 - - *103 + - *89 + - *106 responses: '204': description: Response @@ -17025,8 +17580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 + - *89 + - *106 - *18 - *17 responses: @@ -17044,9 +17599,9 @@ paths: type: number repositories: type: array - items: *105 + items: *108 examples: - default: &538 + default: &541 value: total_count: 1 repositories: @@ -17298,8 +17853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -17343,9 +17898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 - - *96 + - *89 + - *106 + - *99 responses: '204': description: Response @@ -17367,9 +17922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 - - *96 + - *89 + - *106 + - *99 responses: '204': description: Response @@ -17392,8 +17947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 - *17 - *18 responses: @@ -17411,7 +17966,7 @@ paths: type: number runners: type: array - items: &107 + items: &110 title: Self hosted runners description: A self hosted runner type: object @@ -17445,7 +18000,7 @@ paths: type: boolean labels: type: array - items: &110 + items: &113 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -17473,7 +18028,7 @@ paths: - busy - labels examples: - default: &108 + default: &111 value: total_count: 2 runners: @@ -17530,8 +18085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -17575,9 +18130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *86 - - *103 - - &106 + - *89 + - *106 + - &109 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -17605,9 +18160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 - *106 + - *109 responses: '204': description: Response @@ -17637,7 +18192,7 @@ paths: in: query schema: type: string - - *86 + - *89 - *17 - *18 responses: @@ -17655,9 +18210,9 @@ paths: type: integer runners: type: array - items: *107 + items: *110 examples: - default: *108 + default: *111 headers: Link: *37 x-github: @@ -17681,7 +18236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -17689,7 +18244,7 @@ paths: application/json: schema: type: array - items: &256 + items: &259 title: Runner Application description: Runner Application type: object @@ -17714,7 +18269,7 @@ paths: - download_url - filename examples: - default: &257 + default: &260 value: - os: osx architecture: x64 @@ -17757,7 +18312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -17800,7 +18355,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &258 + '201': &261 description: Response content: application/json: @@ -17810,7 +18365,7 @@ paths: - runner - encoded_jit_config properties: - runner: *107 + runner: *110 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17866,13 +18421,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *86 + - *89 responses: '201': description: Response content: application/json: - schema: &109 + schema: &112 title: Authentication Token description: Authentication Token type: object @@ -17896,7 +18451,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *54 + items: *57 single_file: type: - string @@ -17914,7 +18469,7 @@ paths: - token - expires_at examples: - default: &259 + default: &262 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -17945,15 +18500,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *86 + - *89 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: &260 + default: &263 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -17978,16 +18533,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: '200': description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: &261 + default: &264 value: id: 23 name: MBP @@ -18027,8 +18582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: '204': description: Response @@ -18053,10 +18608,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: - '200': &111 + '200': &114 description: Response content: application/json: @@ -18070,7 +18625,7 @@ paths: type: integer labels: type: array - items: *110 + items: *113 examples: default: value: @@ -18109,8 +18664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 requestBody: required: true content: @@ -18134,7 +18689,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18158,8 +18713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 requestBody: required: true content: @@ -18184,7 +18739,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18208,10 +18763,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: - '200': &262 + '200': &265 description: Response content: application/json: @@ -18225,7 +18780,7 @@ paths: type: integer labels: type: array - items: *110 + items: *113 examples: default: value: @@ -18266,9 +18821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 - - &263 + - *89 + - *109 + - &266 name: name description: The name of a self-hosted runner's custom label. in: path @@ -18276,7 +18831,7 @@ paths: schema: type: string responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18301,7 +18856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -18319,7 +18874,7 @@ paths: type: integer secrets: type: array - items: &112 + items: &115 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -18394,13 +18949,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &275 + schema: &278 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -18435,7 +18990,7 @@ paths: - key_id - key examples: - default: &276 + default: &279 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -18460,8 +19015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *86 - - &113 + - *89 + - &116 name: secret_name description: The name of the secret. in: path @@ -18473,7 +19028,7 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: default: value: @@ -18503,8 +19058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -18559,7 +19114,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -18585,8 +19140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -18612,8 +19167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -18631,9 +19186,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: &117 + default: &120 value: total_count: 1 repositories: @@ -18725,8 +19280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -18778,8 +19333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -18812,8 +19367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -18845,8 +19400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *86 - - &249 + - *89 + - &252 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)." @@ -18870,7 +19425,7 @@ paths: type: integer variables: type: array - items: &115 + items: &118 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -18960,7 +19515,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *86 + - *89 requestBody: required: true content: @@ -19008,7 +19563,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -19033,8 +19588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *86 - - &116 + - *89 + - &119 name: name description: The name of the variable. in: path @@ -19046,7 +19601,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *118 examples: default: value: @@ -19076,8 +19631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 requestBody: required: true content: @@ -19139,8 +19694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 responses: '204': description: Response @@ -19166,8 +19721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - *18 - *17 responses: @@ -19185,9 +19740,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19213,8 +19768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 requestBody: required: true content: @@ -19263,8 +19818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - name: repository_id in: path required: true @@ -19298,8 +19853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - name: repository_id in: path required: true @@ -19335,7 +19890,7 @@ paths: - *17 - *41 - *42 - - *86 + - *89 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -19376,7 +19931,7 @@ paths: repository_id: type: integer examples: - default: &289 + default: &292 value: attestations: - bundle: @@ -19483,7 +20038,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -19495,7 +20050,7 @@ paths: type: array items: *4 examples: - default: &161 + default: &164 value: - login: octocat id: 1 @@ -19533,8 +20088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *86 - - &118 + - *89 + - &121 name: username description: The handle for the GitHub user account. in: path @@ -19565,8 +20120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -19586,8 +20141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -19612,18 +20167,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *86 - - &314 + - *89 + - &317 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: &121 + schema: &124 type: string description: The name of the tool used to generate the code scanning analysis. - - &315 + - &318 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 @@ -19631,7 +20186,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &122 + schema: &125 type: - string - 'null' @@ -19647,7 +20202,7 @@ paths: be returned. in: query required: false - schema: &317 + schema: &320 type: string description: State of a code scanning alert. enum: @@ -19670,7 +20225,7 @@ paths: be returned. in: query required: false - schema: &318 + schema: &321 type: string description: Severity of a code scanning alert. enum: @@ -19696,13 +20251,13 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: &319 + instances_url: &322 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &123 + state: &126 type: - string - 'null' @@ -19712,13 +20267,13 @@ paths: - dismissed - fixed - - fixed_at: *119 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: &320 + dismissed_at: *123 + dismissed_reason: &323 type: - string - 'null' @@ -19729,14 +20284,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &321 + dismissed_comment: &324 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &322 + rule: &325 type: object properties: id: @@ -19797,26 +20352,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &323 + tool: &326 type: object properties: - name: *121 + name: *124 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *122 - most_recent_instance: &324 + guid: *125 + most_recent_instance: &327 type: object properties: - ref: &316 + ref: &319 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &330 + analysis_key: &333 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19827,13 +20382,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &331 + category: &334 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: *123 + state: *126 commit_sha: type: string message: @@ -20121,7 +20676,7 @@ paths: headers: Link: *37 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20143,7 +20698,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *86 + - *89 - name: target_type in: query description: The target type of the code security configuration @@ -20171,7 +20726,7 @@ paths: application/json: schema: type: array - items: &124 + items: &127 type: object description: A code security configuration properties: @@ -20410,7 +20965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *86 + - *89 requestBody: required: true content: @@ -20582,9 +21137,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *124 + schema: *127 examples: - default: &126 + default: &129 value: id: 1325 target_type: organization @@ -20630,7 +21185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *86 + - *89 responses: '200': description: Response @@ -20650,7 +21205,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *124 + configuration: *127 examples: default: value: @@ -20734,7 +21289,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *86 + - *89 requestBody: required: true content: @@ -20757,12 +21312,12 @@ paths: - 32 - 91 responses: - '204': &128 + '204': &131 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20784,8 +21339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *86 - - &127 + - *89 + - &130 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20797,9 +21352,9 @@ paths: description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: *126 + default: *129 '304': *35 '403': *27 '404': *6 @@ -20823,8 +21378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -20976,7 +21531,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *124 + schema: *127 examples: default: value: @@ -21027,14 +21582,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 responses: - '204': *128 + '204': *131 '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21058,8 +21613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -21098,7 +21653,7 @@ paths: - 32 - 91 responses: - '202': *91 + '202': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21122,8 +21677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -21163,12 +21718,12 @@ paths: - none - private_and_internal - public - configuration: *124 + configuration: *127 examples: default: value: default_for_new_repos: all - configuration: *126 + configuration: *129 '403': *27 '404': *6 x-github: @@ -21192,8 +21747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 - 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)." @@ -21336,7 +21891,7 @@ paths: parameters: - *17 - *18 - - *86 + - *89 responses: '200': description: Response @@ -21352,7 +21907,7 @@ paths: type: integer codespaces: type: array - items: &162 + items: &165 type: object title: Codespace description: A codespace. @@ -21383,11 +21938,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *105 + repository: *108 machine: anyOf: - type: 'null' - - &344 + - &347 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -21674,7 +22229,7 @@ paths: - pulls_url - recent_folders examples: - default: &163 + default: &166 value: total_count: 3 codespaces: @@ -22106,7 +22661,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *86 + - *89 deprecated: true requestBody: required: true @@ -22173,7 +22728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *86 + - *89 deprecated: true requestBody: required: true @@ -22228,7 +22783,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *86 + - *89 requestBody: required: true content: @@ -22280,7 +22835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -22298,7 +22853,7 @@ paths: type: integer secrets: type: array - items: &129 + items: &132 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -22339,7 +22894,7 @@ paths: - updated_at - visibility examples: - default: &345 + default: &348 value: total_count: 2 secrets: @@ -22371,13 +22926,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &346 + schema: &349 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -22412,7 +22967,7 @@ paths: - key_id - key examples: - default: &347 + default: &350 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22435,16 +22990,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '200': description: Response content: application/json: - schema: *129 + schema: *132 examples: - default: &349 + default: &352 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -22471,8 +23026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -22527,7 +23082,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -22553,8 +23108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -22579,8 +23134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -22598,9 +23153,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 '404': *6 x-github: githubCloudOnly: false @@ -22622,8 +23177,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -22673,8 +23228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -22707,8 +23262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -22747,7 +23302,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *86 + - *89 responses: '200': description: OK @@ -22887,7 +23442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *86 + - *89 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -22910,9 +23465,9 @@ paths: currently being billed. seats: type: array - items: *130 + items: *133 examples: - default: *131 + default: *134 headers: Link: *37 '500': *39 @@ -22950,7 +23505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23028,7 +23583,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23109,7 +23664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23187,7 +23742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23243,6 +23798,74 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - *89 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -23268,7 +23891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *86 + - *89 - 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`). @@ -23300,9 +23923,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: *132 + default: *135 '500': *39 '401': *23 '403': *27 @@ -23328,18 +23951,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *86 - - *133 - - *134 - - *135 + - *89 - *136 - *137 - *138 + - *139 + - *140 + - *141 - *40 - *41 - *42 - - *139 - - *140 + - *142 + - *143 - *17 responses: '200': @@ -23348,9 +23971,9 @@ paths: application/json: schema: type: array - items: *141 + items: *144 examples: - default: *142 + default: *145 '304': *35 '400': *14 '403': *27 @@ -23376,7 +23999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -23394,7 +24017,7 @@ paths: type: integer secrets: type: array - items: &143 + items: &146 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -23467,13 +24090,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &372 + schema: &375 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -23492,7 +24115,7 @@ paths: - key_id - key examples: - default: &373 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23515,14 +24138,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '200': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -23550,8 +24173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -23606,7 +24229,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -23630,8 +24253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -23655,8 +24278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -23674,9 +24297,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23697,8 +24320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -23748,8 +24371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -23780,8 +24403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -23811,7 +24434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -23819,7 +24442,7 @@ paths: application/json: schema: type: array - items: &174 + items: &177 title: Package description: A software package type: object @@ -23872,7 +24495,7 @@ paths: repository: anyOf: - type: 'null' - - *105 + - *108 created_at: type: string format: date-time @@ -23890,7 +24513,7 @@ paths: - created_at - updated_at examples: - default: &175 + default: &178 value: - id: 197 name: hello_docker @@ -23968,7 +24591,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *86 + - *89 - *17 - *18 responses: @@ -23978,7 +24601,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: 200-response: value: @@ -24047,7 +24670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24057,7 +24680,7 @@ paths: application/json: schema: type: array - items: &155 + items: &158 title: Organization Invitation description: Organization Invitation type: object @@ -24111,7 +24734,7 @@ paths: - invitation_teams_url - node_id examples: - default: &156 + default: &159 value: - id: 1 login: monalisa @@ -24166,7 +24789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24176,7 +24799,7 @@ paths: application/json: schema: type: array - items: &144 + items: &147 title: Org Hook description: Org Hook type: object @@ -24299,7 +24922,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *86 + - *89 requestBody: required: true content: @@ -24361,9 +24984,9 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: - default: &145 + default: &148 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -24410,8 +25033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *86 - - &146 + - *89 + - &149 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. @@ -24424,9 +25047,9 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: - default: *145 + default: *148 '404': *6 x-github: githubCloudOnly: false @@ -24453,8 +25076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 requestBody: required: false content: @@ -24500,7 +25123,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: default: value: @@ -24539,8 +25162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 responses: '204': description: Response @@ -24567,8 +25190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *86 - - *146 + - *89 + - *149 responses: '200': description: Response @@ -24598,8 +25221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *86 - - *146 + - *89 + - *149 requestBody: required: false content: @@ -24649,10 +25272,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *17 - - *147 + - *150 - name: redelivery in: query required: false @@ -24665,9 +25288,9 @@ paths: application/json: schema: type: array - items: *148 + items: *151 examples: - default: *149 + default: *152 '400': *14 '422': *15 x-github: @@ -24692,17 +25315,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *16 responses: '200': description: Response content: application/json: - schema: *150 + schema: *153 examples: - default: *151 + default: *154 '400': *14 '422': *15 x-github: @@ -24727,11 +25350,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *16 responses: - '202': *91 + '202': *94 '400': *14 '422': *15 x-github: @@ -24757,8 +25380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 responses: '204': description: Response @@ -24782,7 +25405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *86 + - *89 responses: '200': description: Response @@ -24790,7 +25413,7 @@ paths: application/json: schema: *20 examples: - default: &411 + default: &414 value: id: 1 account: @@ -24859,7 +25482,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24948,7 +25571,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -24956,12 +25579,12 @@ paths: application/json: schema: anyOf: - - &153 + - &156 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &152 + limit: &155 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -24989,7 +25612,7 @@ paths: properties: {} additionalProperties: false examples: - default: &154 + default: &157 value: limit: collaborators_only origin: organization @@ -25013,18 +25636,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: application/json: - schema: &412 + schema: &415 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *152 + limit: *155 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -25049,9 +25672,9 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: - default: *154 + default: *157 '422': *15 x-github: githubCloudOnly: false @@ -25069,7 +25692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -25093,7 +25716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *86 + - *89 - *17 - *18 - name: role @@ -25127,9 +25750,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 '404': *6 @@ -25152,7 +25775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *86 + - *89 requestBody: required: false content: @@ -25206,7 +25829,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *158 examples: default: value: @@ -25260,8 +25883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *86 - - &157 + - *89 + - &160 name: invitation_id description: The unique identifier of the invitation. in: path @@ -25291,8 +25914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *86 - - *157 + - *89 + - *160 - *17 - *18 responses: @@ -25302,9 +25925,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: &173 + default: &176 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -25349,7 +25972,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *86 + - *89 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -25379,7 +26002,7 @@ paths: - closed - all default: open - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -25392,7 +26015,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -25402,9 +26025,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: *160 + default: *163 headers: Link: *37 '404': *6 @@ -25426,7 +26049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *86 + - *89 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -25462,7 +26085,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '422': *15 @@ -25482,8 +26105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response if requester is an organization member and user is @@ -25514,8 +26137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -25541,8 +26164,8 @@ paths: parameters: - *17 - *18 - - *86 - - *118 + - *89 + - *121 responses: '200': description: Response @@ -25558,9 +26181,9 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: - default: *163 + default: *166 '304': *35 '500': *39 '401': *23 @@ -25585,9 +26208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *86 - - *118 - - &164 + - *89 + - *121 + - &167 name: codespace_name in: path required: true @@ -25595,7 +26218,7 @@ paths: schema: type: string responses: - '202': *91 + '202': *94 '304': *35 '500': *39 '401': *23 @@ -25620,17 +26243,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *86 - - *118 - - *164 + - *89 + - *121 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: &343 + default: &346 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -25800,14 +26423,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -25875,14 +26498,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '200': description: Response content: application/json: - schema: &165 + schema: &168 title: Org Membership description: Org Membership type: object @@ -25915,7 +26538,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *85 + organization: *88 user: anyOf: - type: 'null' @@ -25935,7 +26558,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &166 + response-if-user-has-an-active-admin-membership-with-organization: &169 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -26003,8 +26626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 requestBody: required: false content: @@ -26032,9 +26655,9 @@ paths: description: Response content: application/json: - schema: *165 + schema: *168 examples: - response-if-user-already-had-membership-with-organization: *166 + response-if-user-already-had-membership-with-organization: *169 '422': *15 '403': *27 x-github: @@ -26055,8 +26678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -26081,7 +26704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *86 + - *89 - *17 - *18 - name: exclude @@ -26103,7 +26726,7 @@ paths: application/json: schema: type: array - items: &167 + items: &170 title: Migration description: A migration. type: object @@ -26145,7 +26768,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *54 + items: *57 url: type: string format: uri @@ -26360,7 +26983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *86 + - *89 requestBody: required: true content: @@ -26441,7 +27064,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -26619,8 +27242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *86 - - &168 + - *89 + - &171 name: migration_id description: The unique identifier of the migration. in: path @@ -26648,7 +27271,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -26817,8 +27440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *86 - - *168 + - *89 + - *171 responses: '302': description: Response @@ -26839,8 +27462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *86 - - *168 + - *89 + - *171 responses: '204': description: Response @@ -26863,9 +27486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *86 - - *168 - - &551 + - *89 + - *171 + - &554 name: repo_name description: repo_name parameter in: path @@ -26892,8 +27515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *86 - - *168 + - *89 + - *171 - *17 - *18 responses: @@ -26903,9 +27526,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: &180 + default: &183 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -27042,7 +27665,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response - list of organization roles @@ -27058,7 +27681,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &171 + items: &174 title: Organization Role description: Organization roles type: object @@ -27183,8 +27806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -27209,9 +27832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *86 - - *169 - - &170 + - *89 + - *172 + - &173 name: role_id description: The unique identifier of the role. in: path @@ -27246,9 +27869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *86 - - *169 - - *170 + - *89 + - *172 + - *173 responses: '204': description: Response @@ -27273,8 +27896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -27299,9 +27922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *86 - - *118 - - *170 + - *89 + - *121 + - *173 responses: '204': description: Response @@ -27331,9 +27954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *86 - - *118 - - *170 + - *89 + - *121 + - *173 responses: '204': description: Response @@ -27361,14 +27984,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27418,8 +28041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 - *17 - *18 responses: @@ -27488,7 +28111,7 @@ paths: parent: anyOf: - type: 'null' - - *172 + - *175 required: - id - node_id @@ -27502,7 +28125,7 @@ paths: - slug - parent examples: - default: *173 + default: *176 headers: Link: *37 '404': @@ -27531,8 +28154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 - *17 - *18 responses: @@ -27664,7 +28287,7 @@ paths: - type - url examples: - default: *161 + default: *164 headers: Link: *37 '404': @@ -27688,7 +28311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *86 + - *89 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -27712,7 +28335,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -27737,8 +28360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *86 - - *118 + - *89 + - *121 requestBody: required: false content: @@ -27795,8 +28418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -27853,8 +28476,8 @@ paths: - docker - nuget - container - - *86 - - &553 + - *89 + - &556 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -27890,12 +28513,12 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *175 + default: *178 '403': *27 '401': *23 - '400': &555 + '400': &558 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -27917,7 +28540,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &176 + - &179 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 @@ -27935,20 +28558,20 @@ paths: - docker - nuget - container - - &177 + - &180 name: package_name description: The name of the package. in: path required: true schema: type: string - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -28000,9 +28623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 responses: '204': description: Response @@ -28034,9 +28657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 - name: token description: package token schema: @@ -28068,9 +28691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 - *18 - *17 - name: state @@ -28090,7 +28713,7 @@ paths: application/json: schema: type: array - items: &178 + items: &181 title: Package Version description: A version of a software package type: object @@ -28225,10 +28848,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - - &179 + - *179 + - *180 + - *89 + - &182 name: package_version_id description: Unique identifier of the package version. in: path @@ -28240,7 +28863,7 @@ paths: description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -28276,10 +28899,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - *179 + - *180 + - *89 + - *182 responses: '204': description: Response @@ -28311,10 +28934,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - *179 + - *180 + - *89 + - *182 responses: '204': description: Response @@ -28341,10 +28964,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *86 + - *89 - *17 - *18 - - &181 + - &184 name: sort description: The property by which to sort the results. in: query @@ -28355,7 +28978,7 @@ paths: - created_at default: created_at - *40 - - &182 + - &185 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -28367,7 +28990,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &183 + - &186 name: repository description: The name of the repository to use to filter the results. in: query @@ -28376,7 +28999,7 @@ paths: type: string examples: - Hello-World - - &184 + - &187 name: permission description: The permission to use to filter the results. in: query @@ -28385,7 +29008,7 @@ paths: type: string examples: - issues_read - - &185 + - &188 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) @@ -28395,7 +29018,7 @@ paths: schema: type: string format: date-time - - &186 + - &189 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) @@ -28547,7 +29170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *86 + - *89 requestBody: required: true content: @@ -28593,7 +29216,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *91 + '202': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28614,7 +29237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *86 + - *89 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -28655,7 +29278,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *128 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28676,7 +29299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *86 + - *89 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -28696,9 +29319,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -28721,16 +29344,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *86 + - *89 - *17 - *18 - - *181 - - *40 - - *182 - - *183 - *184 + - *40 - *185 - *186 + - *187 + - *188 + - *189 responses: '500': *39 '422': *15 @@ -28867,7 +29490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *86 + - *89 requestBody: required: true content: @@ -28904,7 +29527,7 @@ paths: responses: '500': *39 '404': *6 - '202': *91 + '202': *94 '403': *27 '422': *15 x-github: @@ -28927,7 +29550,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *86 + - *89 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -28957,7 +29580,7 @@ paths: responses: '500': *39 '404': *6 - '204': *128 + '204': *131 '403': *27 '422': *15 x-github: @@ -28979,7 +29602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *86 + - *89 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -28998,9 +29621,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -29022,7 +29645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *86 + - *89 - name: state description: Indicates the state of the projects to return. in: query @@ -29043,7 +29666,7 @@ paths: application/json: schema: type: array - items: &187 + items: &190 title: Project description: Projects are a way to organize columns and cards of work. @@ -29196,7 +29819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *86 + - *89 requestBody: required: true content: @@ -29222,7 +29845,7 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: default: value: @@ -29260,7 +29883,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &236 + '410': &239 description: Gone content: application/json: @@ -29284,7 +29907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -29292,7 +29915,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -29360,7 +29983,7 @@ paths: - property_name - value_type examples: - default: &189 + default: &192 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -29401,7 +30024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -29412,7 +30035,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *188 + items: *191 minItems: 1 maxItems: 100 required: @@ -29442,9 +30065,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '403': *27 '404': *6 x-github: @@ -29465,8 +30088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *86 - - &190 + - *89 + - &193 name: custom_property_name description: The custom property name in: path @@ -29478,9 +30101,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: - default: &191 + default: &194 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -29513,8 +30136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *86 - - *190 + - *89 + - *193 requestBody: required: true content: @@ -29579,9 +30202,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: - default: *191 + default: *194 '403': *27 '404': *6 x-github: @@ -29604,10 +30227,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *86 - - *190 + - *89 + - *193 responses: - '204': *128 + '204': *131 '403': *27 '404': *6 x-github: @@ -29628,7 +30251,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *86 + - *89 - *17 - *18 - name: repository_query @@ -29669,7 +30292,7 @@ paths: - octocat/Hello-World properties: type: array - items: &192 + items: &195 title: Custom Property Value description: Custom property name and associated value type: object @@ -29739,7 +30362,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *86 + - *89 requestBody: required: true content: @@ -29759,7 +30382,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *192 + items: *195 required: - repository_names - properties @@ -29800,7 +30423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *86 + - *89 - *17 - *18 responses: @@ -29812,7 +30435,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -29831,8 +30454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response if user is a public member @@ -29856,8 +30479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -29878,8 +30501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -29903,7 +30526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *86 + - *89 - name: type description: Specifies the types of repositories you want returned. in: query @@ -29949,9 +30572,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -29972,7 +30595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *86 + - *89 requestBody: required: true content: @@ -30154,7 +30777,7 @@ paths: description: Response content: application/json: - schema: &238 + schema: &241 title: Full Repository description: Full Repository type: object @@ -30500,7 +31123,7 @@ paths: template_repository: anyOf: - type: 'null' - - *54 + - *57 temp_clone_token: type: - string @@ -30600,13 +31223,13 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 organization: anyOf: - type: 'null' - *4 - parent: *54 - source: *54 + parent: *57 + source: *57 forks: type: integer master_branch: @@ -30619,7 +31242,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &362 + code_of_conduct: &365 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -30649,7 +31272,7 @@ paths: - key - name - html_url - security_and_analysis: *193 + security_and_analysis: *196 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -30733,7 +31356,7 @@ paths: - network_count - subscribers_count examples: - default: &240 + default: &243 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31251,10 +31874,10 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - *17 - *18 - - &492 + - &495 name: targets description: | A comma-separated list of rule targets to filter by. @@ -31273,7 +31896,7 @@ paths: application/json: schema: type: array - items: &200 + items: &203 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -31306,7 +31929,7 @@ paths: source: type: string description: The name of the source - enforcement: &196 + enforcement: &199 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -31319,7 +31942,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &197 + items: &200 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -31385,7 +32008,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &194 + - &197 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -31409,7 +32032,7 @@ paths: match. items: type: string - - &198 + - &201 title: Organization ruleset conditions type: object description: |- @@ -31422,7 +32045,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -31456,7 +32079,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -31478,7 +32101,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -31491,7 +32114,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &195 + items: &198 title: Repository ruleset property targeting definition type: object @@ -31524,7 +32147,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *195 + items: *198 required: - repository_property type: @@ -31532,12 +32155,12 @@ paths: - object rules: type: array - items: &199 + items: &202 title: Repository Rule type: object description: A repository rule. oneOf: - - &474 + - &477 title: creation description: Only allow users with bypass permission to create matching refs. @@ -31549,7 +32172,7 @@ paths: type: string enum: - creation - - &475 + - &478 title: update description: Only allow users with bypass permission to update matching refs. @@ -31570,7 +32193,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &477 + - &480 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -31582,7 +32205,7 @@ paths: type: string enum: - deletion - - &478 + - &481 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -31594,7 +32217,7 @@ paths: type: string enum: - required_linear_history - - &479 + - &482 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -31672,7 +32295,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &480 + - &483 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -31696,7 +32319,7 @@ paths: type: string required: - required_deployment_environments - - &481 + - &484 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -31708,7 +32331,7 @@ paths: type: string enum: - required_signatures - - &482 + - &485 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -31754,7 +32377,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &483 + - &486 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -31802,7 +32425,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &484 + - &487 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -31814,7 +32437,7 @@ paths: type: string enum: - non_fast_forward - - &485 + - &488 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -31850,7 +32473,7 @@ paths: required: - operator - pattern - - &486 + - &489 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -31886,7 +32509,7 @@ paths: required: - operator - pattern - - &487 + - &490 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -31922,7 +32545,7 @@ paths: required: - operator - pattern - - &488 + - &491 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -31958,7 +32581,7 @@ paths: required: - operator - pattern - - &489 + - &492 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -32084,7 +32707,7 @@ paths: maximum: 100 required: - max_file_size - - &490 + - &493 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -32134,7 +32757,7 @@ paths: - repository_id required: - workflows - - &491 + - &494 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -32247,7 +32870,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 requestBody: description: Request body required: true @@ -32267,16 +32890,16 @@ paths: - tag - push default: branch - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *198 + items: *200 + conditions: *201 rules: type: array description: An array of rules within the ruleset. - items: *199 + items: *202 required: - name - enforcement @@ -32314,9 +32937,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: &201 + default: &204 value: id: 21 name: super cool ruleset @@ -32370,8 +32993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *86 - - &493 + - *89 + - &496 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 @@ -32387,7 +33010,7 @@ paths: in: query schema: type: integer - - &494 + - &497 name: time_period description: |- The time period to filter by. @@ -32403,14 +33026,14 @@ paths: - week - month default: day - - &495 + - &498 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 - - &496 + - &499 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -32430,7 +33053,7 @@ paths: description: Response content: application/json: - schema: &497 + schema: &500 title: Rule Suites description: Response type: array @@ -32486,7 +33109,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &498 + default: &501 value: - id: 21 actor_id: 12 @@ -32529,8 +33152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *86 - - &499 + - *89 + - &502 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -32546,7 +33169,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &503 title: Rule Suite description: Response type: object @@ -32653,7 +33276,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &501 + default: &504 value: id: 21 actor_id: 12 @@ -32714,7 +33337,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32726,9 +33349,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *201 + default: *204 '404': *6 '500': *39 put: @@ -32746,7 +33369,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32771,16 +33394,16 @@ paths: - branch - tag - push - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *198 + items: *200 + conditions: *201 rules: description: An array of rules within the ruleset. type: array - items: *199 + items: *202 examples: default: value: @@ -32815,9 +33438,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *201 + default: *204 '404': *6 '500': *39 delete: @@ -32835,7 +33458,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32863,15 +33486,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *86 - - *202 - - *203 - - *204 + - *89 - *205 + - *206 + - *207 + - *208 - *40 - *18 - *17 - - &503 + - &506 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 @@ -32881,7 +33504,7 @@ paths: required: false schema: type: string - - &504 + - &507 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 @@ -32891,9 +33514,9 @@ paths: required: false schema: type: string - - *206 - - *207 - - *208 + - *209 + - *210 + - *211 responses: '200': description: Response @@ -32901,13 +33524,13 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: - default: *210 + default: *213 headers: Link: *37 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32929,7 +33552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *86 + - *89 - *40 - name: sort description: The property to sort the results by. @@ -32973,7 +33596,7 @@ paths: application/json: schema: type: array - items: &510 + items: &513 description: A repository security advisory. type: object properties: @@ -33217,7 +33840,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 credits_detailed: type: - array @@ -33228,7 +33851,7 @@ paths: type: object properties: user: *4 - type: *211 + type: *214 state: type: string description: The state of the user's acceptance of the @@ -33254,7 +33877,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *158 + items: *161 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -33292,7 +33915,7 @@ paths: - private_fork additionalProperties: false examples: - default: &511 + default: &514 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -33674,7 +34297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *86 + - *89 responses: '200': description: Response @@ -33682,9 +34305,9 @@ paths: application/json: schema: type: array - items: *172 + items: *175 examples: - default: *173 + default: *176 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33707,8 +34330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -33733,8 +34356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -33760,13 +34383,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &569 + schema: &572 type: object properties: total_minutes_used: @@ -33836,7 +34459,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &570 + default: &573 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -33866,13 +34489,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &571 + schema: &574 type: object properties: total_gigabytes_bandwidth_used: @@ -33890,7 +34513,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &572 + default: &575 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -33916,13 +34539,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &573 + schema: &576 type: object properties: days_left_in_billing_cycle: @@ -33940,7 +34563,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &574 + default: &577 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -33950,6 +34573,75 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - *89 + - *172 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -33978,8 +34670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *86 - - *169 + - *89 + - *172 - 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`). @@ -34011,9 +34703,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: *132 + default: *135 '500': *39 '401': *23 '403': *27 @@ -34035,7 +34727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *86 + - *89 - *17 - *18 responses: @@ -34045,9 +34737,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 headers: Link: *37 '403': *27 @@ -34069,7 +34761,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *86 + - *89 requestBody: required: true content: @@ -34141,7 +34833,7 @@ paths: description: Response content: application/json: - schema: &212 + schema: &215 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -34215,7 +34907,7 @@ paths: parent: anyOf: - type: 'null' - - *172 + - *175 members_count: type: integer examples: @@ -34521,7 +35213,7 @@ paths: - repos_count - organization examples: - default: &213 + default: &216 value: id: 1 node_id: MDQ6VGVhbTE= @@ -34591,16 +35283,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *86 - - *169 + - *89 + - *172 responses: '200': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -34621,8 +35313,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *86 - - *169 + - *89 + - *172 requestBody: required: false content: @@ -34685,16 +35377,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '201': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 '422': *15 '403': *27 @@ -34719,8 +35411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -34746,8 +35438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *86 - - *169 + - *89 + - *172 - *40 - *17 - *18 @@ -34764,7 +35456,7 @@ paths: application/json: schema: type: array - items: &214 + items: &217 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -34855,7 +35547,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *56 + reactions: *59 required: - author - body @@ -34875,7 +35567,7 @@ paths: - updated_at - url examples: - default: &525 + default: &528 value: - author: login: octocat @@ -34949,8 +35641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *86 - - *169 + - *89 + - *172 requestBody: required: true content: @@ -34984,9 +35676,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: &215 + default: &218 value: author: login: octocat @@ -35058,9 +35750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *86 - - *169 - - &216 + - *89 + - *172 + - &219 name: discussion_number description: The number that identifies the discussion. in: path @@ -35072,9 +35764,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35096,9 +35788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: false content: @@ -35121,9 +35813,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: &526 + default: &529 value: author: login: octocat @@ -35193,9 +35885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 responses: '204': description: Response @@ -35221,9 +35913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 - *40 - *17 - *18 @@ -35234,7 +35926,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -35299,7 +35991,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *56 + reactions: *59 required: - author - body @@ -35314,7 +36006,7 @@ paths: - updated_at - url examples: - default: &527 + default: &530 value: - author: login: octocat @@ -35382,9 +36074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: true content: @@ -35406,9 +36098,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &218 + default: &221 value: author: login: octocat @@ -35474,10 +36166,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *86 - - *169 - - *216 - - &219 + - *89 + - *172 + - *219 + - &222 name: comment_number description: The number that identifies the comment. in: path @@ -35489,9 +36181,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35513,10 +36205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 requestBody: required: true content: @@ -35538,9 +36230,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &528 + default: &531 value: author: login: octocat @@ -35604,10 +36296,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 responses: '204': description: Response @@ -35633,10 +36325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -35662,7 +36354,7 @@ paths: application/json: schema: type: array - items: &220 + items: &223 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -35706,7 +36398,7 @@ paths: - content - created_at examples: - default: &222 + default: &225 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -35756,10 +36448,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 requestBody: required: true content: @@ -35792,9 +36484,9 @@ paths: team discussion comment content: application/json: - schema: *220 + schema: *223 examples: - default: &221 + default: &224 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -35823,9 +36515,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35848,11 +36540,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 - - &223 + - *222 + - &226 name: reaction_id description: The unique identifier of the reaction. in: path @@ -35884,9 +36576,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -35912,9 +36604,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -35940,9 +36632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: true content: @@ -35974,16 +36666,16 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36006,10 +36698,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *86 - - *169 - - *216 - - *223 + - *89 + - *172 + - *219 + - *226 responses: '204': description: Response @@ -36033,8 +36725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36044,9 +36736,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 x-github: @@ -36068,8 +36760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *86 - - *169 + - *89 + - *172 - name: role description: Filters members returned by their role in the team. in: query @@ -36092,7 +36784,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -36122,15 +36814,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 responses: '200': description: Response content: application/json: - schema: &224 + schema: &227 title: Team Membership description: Team Membership type: object @@ -36158,7 +36850,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &529 + response-if-user-is-a-team-maintainer: &532 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -36194,9 +36886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 requestBody: required: false content: @@ -36221,9 +36913,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-users-membership-with-team-is-now-pending: &530 + response-if-users-membership-with-team-is-now-pending: &533 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -36258,9 +36950,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 responses: '204': description: Response @@ -36286,8 +36978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36297,7 +36989,7 @@ paths: application/json: schema: type: array - items: &225 + items: &228 title: Team Project description: A team's access to a project. type: object @@ -36366,7 +37058,7 @@ paths: - updated_at - permissions examples: - default: &531 + default: &534 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36427,9 +37119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *86 - - *169 - - &226 + - *89 + - *172 + - &229 name: project_id description: The unique identifier of the project. in: path @@ -36441,9 +37133,9 @@ paths: description: Response content: application/json: - schema: *225 + schema: *228 examples: - default: &532 + default: &535 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36503,9 +37195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *86 - - *169 - - *226 + - *89 + - *172 + - *229 requestBody: required: false content: @@ -36570,9 +37262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *86 - - *169 - - *226 + - *89 + - *172 + - *229 responses: '204': description: Response @@ -36596,8 +37288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36607,9 +37299,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -36638,16 +37330,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &533 + schema: &536 title: Team Repository description: A team's access to a repository. type: object @@ -36673,7 +37365,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 forks: type: integer permissions: @@ -37288,10 +37980,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 requestBody: required: false content: @@ -37336,10 +38028,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 responses: '204': description: Response @@ -37363,8 +38055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -37374,9 +38066,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - response-if-child-teams-exist: &534 + response-if-child-teams-exist: &537 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -37429,7 +38121,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *86 + - *89 - name: security_product in: path description: The security feature to enable or disable. @@ -37500,7 +38192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &229 + - &232 name: card_id description: The unique identifier of the card. in: path @@ -37512,7 +38204,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &233 title: Project Card description: Project cards represent a scope of work. type: object @@ -37587,7 +38279,7 @@ paths: - created_at - updated_at examples: - default: &231 + default: &234 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -37637,7 +38329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *229 + - *232 requestBody: required: false content: @@ -37667,9 +38359,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *233 examples: - default: *231 + default: *234 '304': *35 '403': *27 '401': *23 @@ -37690,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *229 + - *232 responses: '204': description: Response @@ -37728,7 +38420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *229 + - *232 requestBody: required: true content: @@ -37835,7 +38527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &232 + - &235 name: column_id description: The unique identifier of the column. in: path @@ -37847,7 +38539,7 @@ paths: description: Response content: application/json: - schema: &233 + schema: &236 title: Project Column description: Project columns contain cards of work. type: object @@ -37901,7 +38593,7 @@ paths: - created_at - updated_at examples: - default: &234 + default: &237 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -37930,7 +38622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *232 + - *235 requestBody: required: true content: @@ -37955,9 +38647,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *234 + default: *237 '304': *35 '403': *27 '401': *23 @@ -37976,7 +38668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *232 + - *235 responses: '204': description: Response @@ -37999,7 +38691,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *232 + - *235 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -38020,7 +38712,7 @@ paths: application/json: schema: type: array - items: *230 + items: *233 examples: default: value: @@ -38073,7 +38765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *232 + - *235 requestBody: required: true content: @@ -38117,9 +38809,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *233 examples: - default: *231 + default: *234 '304': *35 '403': *27 '401': *23 @@ -38129,8 +38821,8 @@ paths: application/json: schema: oneOf: - - *89 - - *90 + - *92 + - *93 '503': description: Response content: @@ -38169,7 +38861,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *232 + - *235 requestBody: required: true content: @@ -38226,15 +38918,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *226 + - *229 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: &235 + default: &238 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -38287,7 +38979,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *226 + - *229 requestBody: required: false content: @@ -38336,9 +39028,9 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *235 + default: *238 '404': description: Not Found if the authenticated user does not have access to the project @@ -38359,7 +39051,7 @@ paths: items: type: string '401': *23 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -38377,7 +39069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *226 + - *229 responses: '204': description: Delete Success @@ -38398,7 +39090,7 @@ paths: items: type: string '401': *23 - '410': *236 + '410': *239 '404': *6 x-github: githubCloudOnly: false @@ -38421,7 +39113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *226 + - *229 - 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 @@ -38448,7 +39140,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -38473,8 +39165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *226 - - *118 + - *229 + - *121 requestBody: required: false content: @@ -38523,8 +39215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *226 - - *118 + - *229 + - *121 responses: '204': description: Response @@ -38552,8 +39244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *226 - - *118 + - *229 + - *121 responses: '200': description: Response @@ -38617,7 +39309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *226 + - *229 - *17 - *18 responses: @@ -38627,7 +39319,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -38659,7 +39351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *226 + - *229 requestBody: required: true content: @@ -38683,7 +39375,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -38744,7 +39436,7 @@ paths: resources: type: object properties: - core: &237 + core: &240 title: Rate Limit type: object properties: @@ -38761,19 +39453,19 @@ paths: - remaining - reset - used - graphql: *237 - search: *237 - code_search: *237 - source_import: *237 - integration_manifest: *237 - code_scanning_upload: *237 - actions_runner_registration: *237 - scim: *237 - dependency_snapshots: *237 + graphql: *240 + search: *240 + code_search: *240 + source_import: *240 + integration_manifest: *240 + code_scanning_upload: *240 + actions_runner_registration: *240 + scim: *240 + dependency_snapshots: *240 required: - core - search - rate: *237 + rate: *240 required: - rate - resources @@ -38872,14 +39564,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *238 + schema: *241 examples: default-response: summary: Default response @@ -39380,7 +40072,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *239 + '301': *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39398,8 +40090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -39636,10 +40328,10 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 - '307': &241 + default: *243 + '307': &244 description: Temporary Redirect content: application/json: @@ -39668,8 +40360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -39691,7 +40383,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *241 + '307': *244 '404': *6 x-github: githubCloudOnly: false @@ -39714,11 +40406,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - - &267 + - &270 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -39741,7 +40433,7 @@ paths: type: integer artifacts: type: array - items: &242 + items: &245 title: Artifact description: An artifact type: object @@ -39827,7 +40519,7 @@ paths: - expires_at - updated_at examples: - default: &268 + default: &271 value: total_count: 2 artifacts: @@ -39886,9 +40578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *227 - - *228 - - &243 + - *230 + - *231 + - &246 name: artifact_id description: The unique identifier of the artifact. in: path @@ -39900,7 +40592,7 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: default: value: @@ -39937,9 +40629,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *227 - - *228 - - *243 + - *230 + - *231 + - *246 responses: '204': description: Response @@ -39963,9 +40655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *227 - - *228 - - *243 + - *230 + - *231 + - *246 - name: archive_format in: path required: true @@ -39979,7 +40671,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40002,14 +40694,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *244 + schema: *247 examples: default: value: @@ -40035,11 +40727,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - - &245 + - &248 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 @@ -40073,7 +40765,7 @@ paths: description: Response content: application/json: - schema: &246 + schema: &249 title: Repository actions caches description: Repository actions caches type: object @@ -40123,7 +40815,7 @@ paths: - total_count - actions_caches examples: - default: &247 + default: &250 value: total_count: 1 actions_caches: @@ -40155,23 +40847,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *227 - - *228 + - *230 + - *231 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *245 + - *248 responses: '200': description: Response content: application/json: - schema: *246 + schema: *249 examples: - default: *247 + default: *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40191,8 +40883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *227 - - *228 + - *230 + - *231 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -40223,9 +40915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *227 - - *228 - - &248 + - *230 + - *231 + - &251 name: job_id description: The unique identifier of the job. in: path @@ -40237,7 +40929,7 @@ paths: description: Response content: application/json: - schema: &271 + schema: &274 title: Job description: Information of a job execution in a workflow run type: object @@ -40584,9 +41276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *227 - - *228 - - *248 + - *230 + - *231 + - *251 responses: '302': description: Response @@ -40614,9 +41306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *227 - - *228 - - *248 + - *230 + - *231 + - *251 requestBody: required: false content: @@ -40638,7 +41330,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -40662,8 +41354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Status response @@ -40713,8 +41405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -40748,7 +41440,7 @@ paths: description: Empty response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -40777,8 +41469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -40796,7 +41488,7 @@ paths: type: integer secrets: type: array - items: &273 + items: &276 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -40817,7 +41509,7 @@ paths: - created_at - updated_at examples: - default: &274 + default: &277 value: total_count: 2 secrets: @@ -40850,9 +41542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *227 - - *228 - - *249 + - *230 + - *231 + - *252 - *18 responses: '200': @@ -40869,7 +41561,7 @@ paths: type: integer variables: type: array - items: &277 + items: &280 title: Actions Variable type: object properties: @@ -40903,7 +41595,7 @@ paths: - created_at - updated_at examples: - default: &278 + default: &281 value: total_count: 2 variables: @@ -40936,8 +41628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -40946,11 +41638,11 @@ paths: schema: type: object properties: - enabled: &251 + enabled: &254 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *95 - selected_actions_url: *250 + allowed_actions: *98 + selected_actions_url: *253 required: - enabled examples: @@ -40977,8 +41669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -40989,8 +41681,8 @@ paths: schema: type: object properties: - enabled: *251 - allowed_actions: *95 + enabled: *254 + allowed_actions: *98 required: - enabled examples: @@ -41019,14 +41711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &252 + schema: &255 type: object properties: access_level: @@ -41043,7 +41735,7 @@ paths: required: - access_level examples: - default: &253 + default: &256 value: access_level: organization x-github: @@ -41067,15 +41759,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: application/json: - schema: *252 + schema: *255 examples: - default: *253 + default: *256 responses: '204': description: Response @@ -41099,16 +41791,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41127,8 +41819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -41136,9 +41828,9 @@ paths: required: false content: application/json: - schema: *97 + schema: *100 examples: - selected_actions: *98 + selected_actions: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41160,16 +41852,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *254 + schema: *257 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41190,8 +41882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Success response @@ -41202,9 +41894,9 @@ paths: required: true content: application/json: - schema: *255 + schema: *258 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41231,8 +41923,8 @@ paths: in: query schema: type: string - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -41250,9 +41942,9 @@ paths: type: integer runners: type: array - items: *107 + items: *110 examples: - default: *108 + default: *111 headers: Link: *37 x-github: @@ -41276,8 +41968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -41285,9 +41977,9 @@ paths: application/json: schema: type: array - items: *256 + items: *259 examples: - default: *257 + default: *260 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41309,8 +42001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -41353,7 +42045,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *261 '404': *6 '422': *7 x-github: @@ -41383,16 +42075,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *259 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41420,16 +42112,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41451,17 +42143,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: '200': description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: *261 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41482,9 +42174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: '204': description: Response @@ -41509,11 +42201,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: - '200': *111 + '200': *114 '404': *6 x-github: githubCloudOnly: false @@ -41535,9 +42227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 requestBody: required: true content: @@ -41561,7 +42253,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41585,9 +42277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 requestBody: required: true content: @@ -41612,7 +42304,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41636,11 +42328,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: - '200': *262 + '200': *265 '404': *6 x-github: githubCloudOnly: false @@ -41667,12 +42359,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 - - *263 + - *230 + - *231 + - *109 + - *266 responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41698,9 +42390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *227 - - *228 - - &281 + - *230 + - *231 + - &284 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. @@ -41708,7 +42400,7 @@ paths: required: false schema: type: string - - &282 + - &285 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -41716,7 +42408,7 @@ paths: required: false schema: type: string - - &283 + - &286 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -41725,7 +42417,7 @@ paths: required: false schema: type: string - - &284 + - &287 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 @@ -41752,7 +42444,7 @@ paths: - pending - *17 - *18 - - &285 + - &288 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)." @@ -41761,7 +42453,7 @@ paths: schema: type: string format: date-time - - &264 + - &267 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -41770,13 +42462,13 @@ paths: schema: type: boolean default: false - - &286 + - &289 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &287 + - &290 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -41799,7 +42491,7 @@ paths: type: integer workflow_runs: type: array - items: &265 + items: &268 title: Workflow Run description: An invocation of a workflow type: object @@ -41916,7 +42608,7 @@ paths: type: - array - 'null' - items: &306 + items: &309 title: Pull Request Minimal type: object properties: @@ -42043,7 +42735,7 @@ paths: head_commit: anyOf: - type: 'null' - - &310 + - &313 title: Simple Commit description: A commit. type: object @@ -42117,8 +42809,8 @@ paths: - timestamp - author - committer - repository: *105 - head_repository: *105 + repository: *108 + head_repository: *108 head_repository_id: type: integer examples: @@ -42158,7 +42850,7 @@ paths: - workflow_url - pull_requests examples: - default: &288 + default: &291 value: total_count: 1 workflow_runs: @@ -42394,24 +43086,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *227 - - *228 - - &266 + - *230 + - *231 + - &269 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *264 + - *267 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: &269 + default: &272 value: id: 30433642 name: Build @@ -42652,9 +43344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '204': description: Response @@ -42677,9 +43369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -42807,15 +43499,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -42842,12 +43534,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 - *17 - *18 - - *267 + - *270 responses: '200': description: Response @@ -42863,9 +43555,9 @@ paths: type: integer artifacts: type: array - items: *242 + items: *245 examples: - default: *268 + default: *271 headers: Link: *37 x-github: @@ -42889,25 +43581,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *227 - - *228 - - *266 - - &270 + - *230 + - *231 + - *269 + - &273 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *264 + - *267 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *269 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42930,10 +43622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *227 - - *228 - - *266 - - *270 + - *230 + - *231 + - *269 + - *273 - *17 - *18 responses: @@ -42951,9 +43643,9 @@ paths: type: integer jobs: type: array - items: *271 + items: *274 examples: - default: &272 + default: &275 value: total_count: 1 jobs: @@ -43066,10 +43758,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *227 - - *228 - - *266 - - *270 + - *230 + - *231 + - *269 + - *273 responses: '302': description: Response @@ -43097,19 +43789,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '202': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43132,9 +43824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: true content: @@ -43201,19 +43893,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '202': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43236,9 +43928,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 - 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 @@ -43268,9 +43960,9 @@ paths: type: integer jobs: type: array - items: *271 + items: *274 examples: - default: *272 + default: *275 headers: Link: *37 x-github: @@ -43295,9 +43987,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '302': description: Response @@ -43324,9 +44016,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '204': description: Response @@ -43353,9 +44045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -43424,7 +44116,7 @@ paths: items: type: object properties: - type: &381 + type: &384 type: string description: The type of reviewer. enum: @@ -43435,7 +44127,7 @@ paths: reviewer: anyOf: - *4 - - *158 + - *161 required: - environment - wait_timer @@ -43510,9 +44202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: true content: @@ -43562,7 +44254,7 @@ paths: application/json: schema: type: array - items: &376 + items: &379 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -43674,7 +44366,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &380 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -43730,9 +44422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: false content: @@ -43754,7 +44446,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -43777,9 +44469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: false content: @@ -43801,7 +44493,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -43826,9 +44518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -43965,8 +44657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -43984,9 +44676,9 @@ paths: type: integer secrets: type: array - items: *273 + items: *276 examples: - default: *274 + default: *277 headers: Link: *37 x-github: @@ -44011,16 +44703,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44042,17 +44734,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: &394 + default: &397 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44078,9 +44770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -44108,7 +44800,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -44134,9 +44826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -44161,9 +44853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *227 - - *228 - - *249 + - *230 + - *231 + - *252 - *18 responses: '200': @@ -44180,9 +44872,9 @@ paths: type: integer variables: type: array - items: *277 + items: *280 examples: - default: *278 + default: *281 headers: Link: *37 x-github: @@ -44205,8 +44897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -44233,7 +44925,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -44258,17 +44950,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: &395 + default: &398 value: name: USERNAME value: octocat @@ -44294,9 +44986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 requestBody: required: true content: @@ -44338,9 +45030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 responses: '204': description: Response @@ -44365,8 +45057,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -44384,7 +45076,7 @@ paths: type: integer workflows: type: array - items: &279 + items: &282 title: Workflow description: A GitHub Actions workflow type: object @@ -44502,9 +45194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *227 - - *228 - - &280 + - *230 + - *231 + - &283 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -44519,7 +45211,7 @@ paths: description: Response content: application/json: - schema: *279 + schema: *282 examples: default: value: @@ -44552,9 +45244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44579,9 +45271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44632,9 +45324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44659,19 +45351,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *227 - - *228 - - *280 - - *281 - - *282 + - *230 + - *231 - *283 - *284 - - *17 - - *18 - *285 - - *264 - *286 - *287 + - *17 + - *18 + - *288 + - *267 + - *289 + - *290 responses: '200': description: Response @@ -44687,9 +45379,9 @@ paths: type: integer workflow_runs: type: array - items: *265 + items: *268 examples: - default: *288 + default: *291 headers: Link: *37 x-github: @@ -44715,9 +45407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '200': description: Response @@ -44778,8 +45470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *227 - - *228 + - *230 + - *231 - *40 - *17 - *41 @@ -44947,8 +45639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -44960,7 +45652,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -44985,8 +45677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *227 - - *228 + - *230 + - *231 - name: assignee in: path required: true @@ -45022,8 +45714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -45135,8 +45827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *41 - *42 @@ -45180,7 +45872,7 @@ paths: repository_id: type: integer examples: - default: *289 + default: *292 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45200,8 +45892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -45209,7 +45901,7 @@ paths: application/json: schema: type: array - items: &290 + items: &293 title: Autolink reference description: An autolink reference. type: object @@ -45263,8 +45955,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -45303,9 +45995,9 @@ paths: description: response content: application/json: - schema: *290 + schema: *293 examples: - default: &291 + default: &294 value: id: 1 key_prefix: TICKET- @@ -45336,9 +46028,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *227 - - *228 - - &292 + - *230 + - *231 + - &295 name: autolink_id description: The unique identifier of the autolink. in: path @@ -45350,9 +46042,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: *291 + default: *294 '404': *6 x-github: githubCloudOnly: false @@ -45372,9 +46064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *227 - - *228 - - *292 + - *230 + - *231 + - *295 responses: '204': description: Response @@ -45398,8 +46090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response if Dependabot is enabled @@ -45449,8 +46141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -45471,8 +46163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -45492,8 +46184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *227 - - *228 + - *230 + - *231 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -45531,7 +46223,7 @@ paths: - url protected: type: boolean - protection: &294 + protection: &297 title: Branch Protection description: Branch Protection type: object @@ -45574,7 +46266,7 @@ paths: required: - contexts - checks - enforce_admins: &297 + enforce_admins: &300 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -45591,7 +46283,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &299 + required_pull_request_reviews: &302 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -45613,7 +46305,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *158 + items: *161 apps: description: The list of apps with review dismissal access. @@ -45645,7 +46337,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *158 + items: *161 apps: description: The list of apps allowed to bypass pull request requirements. @@ -45675,7 +46367,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &296 + restrictions: &299 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -46000,9 +46692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *227 - - *228 - - &295 + - *230 + - *231 + - &298 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). @@ -46016,14 +46708,14 @@ paths: description: Response content: application/json: - schema: &305 + schema: &308 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &352 + commit: &355 title: Commit description: Commit type: object @@ -46062,7 +46754,7 @@ paths: author: anyOf: - type: 'null' - - &293 + - &296 title: Git User description: Metaproperties for Git author/committer information. @@ -46083,7 +46775,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 message: type: string examples: @@ -46107,7 +46799,7 @@ paths: required: - sha - url - verification: &401 + verification: &404 title: Verification type: object properties: @@ -46138,14 +46830,14 @@ paths: author: oneOf: - *4 - - *114 + - *117 type: - 'null' - object committer: oneOf: - *4 - - *114 + - *117 type: - 'null' - object @@ -46182,7 +46874,7 @@ paths: type: integer files: type: array - items: &364 + items: &367 title: Diff Entry description: Diff Entry type: object @@ -46276,7 +46968,7 @@ paths: - self protected: type: boolean - protection: *294 + protection: *297 protection_url: type: string format: uri @@ -46384,7 +47076,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *239 + '301': *242 '404': *6 x-github: githubCloudOnly: false @@ -46406,15 +47098,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -46608,9 +47300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -46870,7 +47562,7 @@ paths: url: type: string format: uri - required_status_checks: &302 + required_status_checks: &305 title: Status Check Policy description: Status Check Policy type: object @@ -46951,7 +47643,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 apps: type: array items: *5 @@ -46969,7 +47661,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 apps: type: array items: *5 @@ -47029,7 +47721,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *296 + restrictions: *299 required_conversation_resolution: type: object properties: @@ -47141,9 +47833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47168,17 +47860,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: &298 + default: &301 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -47200,17 +47892,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47229,9 +47921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47256,17 +47948,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *299 + schema: *302 examples: - default: &300 + default: &303 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -47362,9 +48054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47462,9 +48154,9 @@ paths: description: Response content: application/json: - schema: *299 + schema: *302 examples: - default: *300 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -47485,9 +48177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47514,17 +48206,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: &301 + default: &304 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -47547,17 +48239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *301 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -47577,9 +48269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47604,17 +48296,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: &303 + default: &306 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -47640,9 +48332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47694,9 +48386,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: *303 + default: *306 '404': *6 '422': *15 x-github: @@ -47718,9 +48410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47744,9 +48436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -47780,9 +48472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47849,9 +48541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47915,9 +48607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: content: application/json: @@ -47983,15 +48675,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *296 + schema: *299 examples: default: value: @@ -48082,9 +48774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -48107,9 +48799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48119,7 +48811,7 @@ paths: type: array items: *5 examples: - default: &304 + default: &307 value: - id: 1 slug: octoapp @@ -48176,9 +48868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48212,7 +48904,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48233,9 +48925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48269,7 +48961,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48290,9 +48982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48326,7 +49018,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48348,9 +49040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48358,9 +49050,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '404': *6 x-github: githubCloudOnly: false @@ -48380,9 +49072,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -48418,9 +49110,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48441,9 +49133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -48479,9 +49171,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48502,9 +49194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: content: application/json: @@ -48539,9 +49231,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48563,9 +49255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48575,7 +49267,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '404': *6 x-github: githubCloudOnly: false @@ -48599,9 +49291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48634,7 +49326,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48659,9 +49351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48694,7 +49386,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48719,9 +49411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48754,7 +49446,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48781,9 +49473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48805,7 +49497,7 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: default: value: @@ -48920,8 +49612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -49200,7 +49892,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &310 title: CheckRun description: A check performed on the code of a given code change type: object @@ -49335,8 +50027,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *306 - deployment: &583 + items: *309 + deployment: &586 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -49623,9 +50315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *227 - - *228 - - &308 + - *230 + - *231 + - &311 name: check_run_id description: The unique identifier of the check run. in: path @@ -49637,9 +50329,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *310 examples: - default: &309 + default: &312 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -49739,9 +50431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 requestBody: required: true content: @@ -49981,9 +50673,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *310 examples: - default: *309 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50003,9 +50695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 - *17 - *18 responses: @@ -50117,15 +50809,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -50163,8 +50855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -50186,7 +50878,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &311 + schema: &314 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -50267,12 +50959,12 @@ paths: type: - array - 'null' - items: *306 + items: *309 app: anyOf: - type: 'null' - *5 - repository: *105 + repository: *108 created_at: type: - string @@ -50283,7 +50975,7 @@ paths: - string - 'null' format: date-time - head_commit: *310 + head_commit: *313 latest_check_runs_count: type: integer check_runs_url: @@ -50311,7 +51003,7 @@ paths: - check_runs_url - pull_requests examples: - default: &312 + default: &315 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -50602,9 +51294,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50623,8 +51315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -50685,7 +51377,7 @@ paths: required: - app_id - setting - repository: *105 + repository: *108 examples: default: value: @@ -50933,9 +51625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *227 - - *228 - - &313 + - *230 + - *231 + - &316 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -50947,9 +51639,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50972,17 +51664,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *227 - - *228 - - *313 - - &359 + - *230 + - *231 + - *316 + - &362 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &360 + - &363 name: status description: Returns check runs with the specified `status`. in: query @@ -51021,9 +51713,9 @@ paths: type: integer check_runs: type: array - items: *307 + items: *310 examples: - default: &361 + default: &364 value: total_count: 1 check_runs: @@ -51125,15 +51817,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *227 - - *228 - - *313 + - *230 + - *231 + - *316 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -51160,21 +51852,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *227 - - *228 - - *314 - - *315 + - *230 + - *231 + - *317 + - *318 - *18 - *17 - - &328 + - &331 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: *316 - - &329 + schema: *319 + - &332 name: pr description: The number of the pull request for the results you want to list. in: query @@ -51199,13 +51891,13 @@ paths: be returned. in: query required: false - schema: *317 + schema: *320 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *318 + schema: *321 responses: '200': description: Response @@ -51221,19 +51913,19 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: *319 - state: *123 - fixed_at: *119 + instances_url: *322 + state: *126 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: *320 - dismissed_comment: *321 - rule: *322 - tool: *323 - most_recent_instance: *324 + dismissed_at: *123 + dismissed_reason: *323 + dismissed_comment: *324 + rule: *325 + tool: *326 + most_recent_instance: *327 required: - number - created_at @@ -51349,14 +52041,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &325 + '403': &328 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51376,9 +52068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *227 - - *228 - - &326 + - *230 + - *231 + - &329 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -51392,7 +52084,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &330 type: object properties: number: *46 @@ -51400,16 +52092,16 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: *319 - state: *123 - fixed_at: *119 + instances_url: *322 + state: *126 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: *320 - dismissed_comment: *321 + dismissed_at: *123 + dismissed_reason: *323 + dismissed_comment: *324 rule: type: object properties: @@ -51471,8 +52163,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *323 - most_recent_instance: *324 + tool: *326 + most_recent_instance: *327 required: - number - created_at @@ -51561,9 +52253,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51581,9 +52273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 requestBody: required: true content: @@ -51598,8 +52290,8 @@ paths: enum: - open - dismissed - dismissed_reason: *320 - dismissed_comment: *321 + dismissed_reason: *323 + dismissed_comment: *324 required: - state examples: @@ -51614,7 +52306,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *330 examples: default: value: @@ -51689,14 +52381,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &334 + '403': &337 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51716,13 +52408,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 - *18 - *17 - - *328 - - *329 + - *331 + - *332 responses: '200': description: Response @@ -51730,7 +52422,7 @@ paths: application/json: schema: type: array - items: *324 + items: *327 examples: default: value: @@ -51769,9 +52461,9 @@ paths: end_column: 50 classifications: - source - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51803,25 +52495,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *227 - - *228 - - *314 - - *315 + - *230 + - *231 + - *317 + - *318 - *18 - *17 - - *329 + - *332 - 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: *316 + schema: *319 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &332 + schema: &335 type: string description: An identifier for the upload. examples: @@ -51843,23 +52535,23 @@ paths: application/json: schema: type: array - items: &333 + items: &336 type: object properties: - ref: *316 - commit_sha: &342 + ref: *319 + commit_sha: &345 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: *330 + analysis_key: *333 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *331 + category: *334 error: type: string examples: @@ -51884,8 +52576,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *332 - tool: *323 + sarif_id: *335 + tool: *326 deletable: type: boolean warning: @@ -51947,9 +52639,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51983,8 +52675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -51997,7 +52689,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *336 examples: response: summary: application/json response @@ -52051,9 +52743,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52133,8 +52825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52190,9 +52882,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *334 + '403': *337 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52212,8 +52904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -52221,7 +52913,7 @@ paths: application/json: schema: type: array - items: &335 + items: &338 title: CodeQL Database description: A CodeQL database. type: object @@ -52333,9 +53025,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52362,8 +53054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: language in: path description: The language of the CodeQL database. @@ -52375,7 +53067,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *338 examples: default: value: @@ -52407,11 +53099,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &366 + '302': &369 description: Found - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52437,8 +53129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -52447,7 +53139,7 @@ paths: type: object additionalProperties: false properties: - language: &336 + language: &339 type: string description: The language targeted by the CodeQL query enum: @@ -52525,7 +53217,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &340 + schema: &343 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -52535,7 +53227,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *336 + query_language: *339 query_pack_url: type: string description: The download url for the query pack. @@ -52583,7 +53275,7 @@ paths: items: type: object properties: - repository: &337 + repository: &340 title: Repository Identifier description: Repository Identifier type: object @@ -52625,7 +53317,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &341 + analysis_status: &344 type: string description: The new status of the CodeQL variant analysis repository task. @@ -52657,7 +53349,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &338 + access_mismatch_repos: &341 type: object properties: repository_count: @@ -52672,7 +53364,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: *337 + items: *340 required: - repository_count - repositories @@ -52695,8 +53387,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *338 - over_limit_repos: *338 + no_codeql_db_repos: *341 + over_limit_repos: *341 required: - access_mismatch_repos - not_found_repos @@ -52712,7 +53404,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &339 + value: &342 summary: Default response value: id: 1 @@ -52864,17 +53556,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *339 + value: *342 repository_lists: summary: Response for a successful variant analysis submission - value: *339 + value: *342 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52895,8 +53587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *227 - - *228 + - *230 + - *231 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -52908,11 +53600,11 @@ paths: description: Response content: application/json: - schema: *340 + schema: *343 examples: - default: *339 + default: *342 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52933,7 +53625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *227 + - *230 - name: repo in: path description: The name of the controller repository. @@ -52968,7 +53660,7 @@ paths: type: object properties: repository: *51 - analysis_status: *341 + analysis_status: *344 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -53072,7 +53764,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53093,8 +53785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53159,9 +53851,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53180,8 +53872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -53226,7 +53918,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -53251,7 +53943,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *334 + '403': *337 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -53259,7 +53951,7 @@ paths: content: application/json: schema: *3 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53316,8 +54008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -53325,7 +54017,7 @@ paths: schema: type: object properties: - commit_sha: *342 + commit_sha: *345 ref: type: string description: |- @@ -53385,7 +54077,7 @@ paths: schema: type: object properties: - id: *332 + id: *335 url: type: string description: The REST API URL for checking the status of the upload. @@ -53399,11 +54091,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *334 + '403': *337 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53422,8 +54114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *227 - - *228 + - *230 + - *231 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -53471,10 +54163,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *325 + '403': *328 '404': description: Not Found if the sarif id does not match any upload - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53496,8 +54188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53521,7 +54213,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *124 + configuration: *127 examples: default: value: @@ -53550,7 +54242,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': *128 + '204': *131 '304': *35 '403': *27 '404': *6 @@ -53575,8 +54267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -53704,8 +54396,8 @@ paths: parameters: - *17 - *18 - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53721,7 +54413,7 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: default: value: @@ -54019,8 +54711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -54084,22 +54776,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54123,8 +54815,8 @@ paths: parameters: - *17 - *18 - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -54188,8 +54880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -54226,9 +54918,9 @@ paths: type: integer machines: type: array - items: *344 + items: *347 examples: - default: &541 + default: &544 value: total_count: 2 machines: @@ -54268,8 +54960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *227 - - *228 + - *230 + - *231 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -54356,8 +55048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -54405,7 +55097,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54426,8 +55118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -54445,7 +55137,7 @@ paths: type: integer secrets: type: array - items: &348 + items: &351 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -54466,7 +55158,7 @@ paths: - created_at - updated_at examples: - default: *345 + default: *348 headers: Link: *37 x-github: @@ -54489,16 +55181,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54518,17 +55210,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *348 + schema: *351 examples: - default: *349 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54548,9 +55240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -54578,7 +55270,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -54602,9 +55294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -54632,8 +55324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *227 - - *228 + - *230 + - *231 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -54671,7 +55363,7 @@ paths: application/json: schema: type: array - items: &350 + items: &353 title: Collaborator description: Collaborator type: object @@ -54864,9 +55556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '204': description: Response if user is a collaborator @@ -54908,9 +55600,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 requestBody: required: false content: @@ -54936,7 +55628,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &414 + schema: &417 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -54948,7 +55640,7 @@ paths: format: int64 examples: - 42 - repository: *105 + repository: *108 invitee: anyOf: - type: 'null' @@ -55157,9 +55849,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '204': description: No Content when collaborator was removed from the repository. @@ -55188,9 +55880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '200': description: if user has admin permissions @@ -55210,7 +55902,7 @@ paths: user: anyOf: - type: 'null' - - *350 + - *353 required: - permission - role_name @@ -55264,8 +55956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -55275,7 +55967,7 @@ paths: application/json: schema: type: array - items: &351 + items: &354 title: Commit Comment description: Commit Comment type: object @@ -55316,8 +56008,8 @@ paths: updated_at: type: string format: date-time - author_association: *55 - reactions: *56 + author_association: *58 + reactions: *59 required: - url - html_url @@ -55333,7 +56025,7 @@ paths: - created_at - updated_at examples: - default: &354 + default: &357 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55392,17 +56084,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: &355 + default: &358 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55459,9 +56151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -55483,7 +56175,7 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: default: value: @@ -55534,9 +56226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -55557,9 +56249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -55585,9 +56277,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -55608,9 +56300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -55642,16 +56334,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -55673,10 +56365,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -55724,8 +56416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *227 - - *228 + - *230 + - *231 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -55781,9 +56473,9 @@ paths: application/json: schema: type: array - items: *352 + items: *355 examples: - default: &461 + default: &464 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55856,7 +56548,7 @@ paths: '500': *39 '400': *14 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55876,9 +56568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *227 - - *228 - - &353 + - *230 + - *231 + - &356 name: commit_sha description: The SHA of the commit. in: path @@ -55925,7 +56617,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55950,9 +56642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 - *17 - *18 responses: @@ -55962,9 +56654,9 @@ paths: application/json: schema: type: array - items: *351 + items: *354 examples: - default: *354 + default: *357 headers: Link: *37 x-github: @@ -55992,9 +56684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 requestBody: required: true content: @@ -56029,9 +56721,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: *355 + default: *358 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56059,9 +56751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 - *17 - *18 responses: @@ -56071,7 +56763,7 @@ paths: application/json: schema: type: array - items: &452 + items: &455 title: Pull Request Simple description: Pull Request Simple type: object @@ -56191,7 +56883,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 active_lock_reason: type: - string @@ -56246,7 +56938,7 @@ paths: type: - array - 'null' - items: *158 + items: *161 head: type: object properties: @@ -56254,7 +56946,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: @@ -56274,7 +56966,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: @@ -56290,7 +56982,7 @@ paths: _links: type: object properties: - comments: &357 + comments: &360 title: Link description: Hypermedia Link type: object @@ -56299,13 +56991,13 @@ paths: type: string required: - href - commits: *357 - statuses: *357 - html: *357 - issue: *357 - review_comments: *357 - review_comment: *357 - self: *357 + commits: *360 + statuses: *360 + html: *360 + issue: *360 + review_comments: *360 + review_comment: *360 + self: *360 required: - comments - commits @@ -56315,8 +57007,8 @@ paths: - review_comments - review_comment - self - author_association: *55 - auto_merge: &454 + author_association: *58 + auto_merge: &457 title: Auto merge description: The status of auto merging a pull request. type: @@ -56381,7 +57073,7 @@ paths: - author_association - auto_merge examples: - default: &453 + default: &456 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -56861,7 +57553,7 @@ paths: draft: false headers: Link: *37 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56917,11 +57609,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 - - &358 + - &361 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)" @@ -56936,9 +57628,9 @@ paths: description: Response content: application/json: - schema: *352 + schema: *355 examples: - default: &440 + default: &443 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57024,8 +57716,8 @@ paths: '422': *15 '404': *6 '500': *39 - '503': *57 - '409': *125 + '503': *60 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57050,11 +57742,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *227 - - *228 - - *358 - - *359 - - *360 + - *230 + - *231 + - *361 + - *362 + - *363 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -57088,9 +57780,9 @@ paths: type: integer check_runs: type: array - items: *307 + items: *310 examples: - default: *361 + default: *364 headers: Link: *37 x-github: @@ -57115,9 +57807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -57125,7 +57817,7 @@ paths: schema: type: integer example: 1 - - *359 + - *362 - *17 - *18 responses: @@ -57143,7 +57835,7 @@ paths: type: integer check_suites: type: array - items: *311 + items: *314 examples: default: value: @@ -57343,9 +58035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - *17 - *18 responses: @@ -57416,7 +58108,7 @@ paths: type: string total_count: type: integer - repository: *105 + repository: *108 commit_url: type: string format: uri @@ -57547,9 +58239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - *17 - *18 responses: @@ -57559,7 +58251,7 @@ paths: application/json: schema: type: array - items: &515 + items: &518 title: Status description: The status of a commit. type: object @@ -57640,7 +58332,7 @@ paths: site_admin: false headers: Link: *37 - '301': *239 + '301': *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57668,8 +58360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -57702,11 +58394,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *362 + - *365 code_of_conduct_file: anyOf: - type: 'null' - - &363 + - &366 title: Community Health File type: object properties: @@ -57722,23 +58414,23 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 contributing: anyOf: - type: 'null' - - *363 + - *366 readme: anyOf: - type: 'null' - - *363 + - *366 issue_template: anyOf: - type: 'null' - - *363 + - *366 pull_request_template: anyOf: - type: 'null' - - *363 + - *366 required: - code_of_conduct - code_of_conduct_file @@ -57866,8 +58558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 - name: basehead @@ -57915,8 +58607,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *352 - merge_base_commit: *352 + base_commit: *355 + merge_base_commit: *355 status: type: string enum: @@ -57940,10 +58632,10 @@ paths: - 6 commits: type: array - items: *352 + items: *355 files: type: array - items: *364 + items: *367 required: - url - html_url @@ -58184,7 +58876,7 @@ paths: module Test" '404': *6 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58226,8 +58918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -58378,7 +59070,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &365 + response-if-content-is-a-file: &368 summary: Response if content is a file value: type: file @@ -58515,7 +59207,7 @@ paths: - size - type - url - - &466 + - &469 title: Content File description: Content File type: object @@ -58733,7 +59425,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *365 + response-if-content-is-a-file: *368 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -58802,7 +59494,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *366 + '302': *369 '304': *35 x-github: githubCloudOnly: false @@ -58825,8 +59517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -58921,7 +59613,7 @@ paths: description: Response content: application/json: - schema: &367 + schema: &370 title: File Commit description: File Commit type: object @@ -59072,7 +59764,7 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: example-for-creating-a-file: value: @@ -59125,7 +59817,7 @@ paths: schema: oneOf: - *3 - - &396 + - &399 description: Repository rule violation was detected type: object properties: @@ -59146,7 +59838,7 @@ paths: items: type: object properties: - placeholder_id: &508 + placeholder_id: &511 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -59178,8 +59870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -59240,7 +59932,7 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: default: value: @@ -59273,8 +59965,8 @@ paths: payload: '422': *15 '404': *6 - '409': *125 - '503': *57 + '409': *128 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59294,8 +59986,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *227 - - *228 + - *230 + - *231 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -59419,20 +60111,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *227 - - *228 - - *133 - - *134 - - *135 + - *230 + - *231 - *136 + - *137 + - *138 + - *139 - 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 - - *137 - - *138 + - *140 + - *141 - *40 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -59452,8 +60144,8 @@ paths: default: 30 - *41 - *42 - - *139 - - *140 + - *142 + - *143 responses: '200': description: Response @@ -59461,7 +60153,7 @@ paths: application/json: schema: type: array - items: &370 + items: &373 type: object description: A Dependabot alert. properties: @@ -59496,13 +60188,13 @@ paths: - development - runtime - - security_advisory: *368 + security_advisory: *371 security_vulnerability: *45 url: *49 html_url: *50 created_at: *47 updated_at: *48 - dismissed_at: *120 + dismissed_at: *123 dismissed_by: anyOf: - type: 'null' @@ -59526,8 +60218,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: *369 + fixed_at: *122 + auto_dismissed_at: *372 required: - number - state @@ -59754,9 +60446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *227 - - *228 - - &371 + - *230 + - *231 + - &374 name: alert_number in: path description: |- @@ -59771,7 +60463,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *373 examples: default: value: @@ -59881,9 +60573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *227 - - *228 - - *371 + - *230 + - *231 + - *374 requestBody: required: true content: @@ -59928,7 +60620,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *373 examples: default: value: @@ -60034,7 +60726,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 '422': *7 x-github: githubCloudOnly: false @@ -60057,8 +60749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -60076,7 +60768,7 @@ paths: type: integer secrets: type: array - items: &374 + items: &377 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -60130,16 +60822,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *372 + schema: *375 examples: - default: *373 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60159,15 +60851,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *374 + schema: *377 examples: default: value: @@ -60193,9 +60885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -60223,7 +60915,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -60247,9 +60939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -60271,8 +60963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -60446,8 +61138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -60670,8 +61362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -60754,7 +61446,7 @@ paths: - version - url additionalProperties: false - metadata: &375 + metadata: &378 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -60793,7 +61485,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *375 + metadata: *378 resolved: type: object description: A collection of resolved package dependencies. @@ -60807,7 +61499,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *375 + metadata: *378 relationship: type: string description: A notation of whether a dependency is requested @@ -60940,8 +61632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *227 - - *228 + - *230 + - *231 - name: sha description: The SHA recorded at creation time. in: query @@ -60982,9 +61674,9 @@ paths: application/json: schema: type: array - items: *376 + items: *379 examples: - default: *377 + default: *380 headers: Link: *37 x-github: @@ -61050,8 +61742,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -61133,7 +61825,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: simple-example: summary: Simple example @@ -61206,9 +61898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *227 - - *228 - - &378 + - *230 + - *231 + - &381 name: deployment_id description: deployment_id parameter in: path @@ -61220,7 +61912,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: default: value: @@ -61285,9 +61977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 responses: '204': description: Response @@ -61309,9 +62001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 - *17 - *18 responses: @@ -61321,7 +62013,7 @@ paths: application/json: schema: type: array - items: &379 + items: &382 title: Deployment Status description: The status of a deployment. type: object @@ -61485,9 +62177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 requestBody: required: true content: @@ -61562,9 +62254,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *382 examples: - default: &380 + default: &383 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -61620,9 +62312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 - name: status_id in: path required: true @@ -61633,9 +62325,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *382 examples: - default: *380 + default: *383 '404': *6 x-github: githubCloudOnly: false @@ -61660,8 +62352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -61718,8 +62410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -61737,7 +62429,7 @@ paths: - 5 environments: type: array - items: &382 + items: &385 title: Environment description: Details of a deployment environment type: object @@ -61799,7 +62491,7 @@ paths: type: string examples: - wait_timer - wait_timer: &384 + wait_timer: &387 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -61841,11 +62533,11 @@ paths: items: type: object properties: - type: *381 + type: *384 reviewer: anyOf: - *4 - - *158 + - *161 required: - id - node_id @@ -61868,7 +62560,7 @@ paths: - id - node_id - type - deployment_branch_policy: &385 + deployment_branch_policy: &388 type: - object - 'null' @@ -61985,9 +62677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *227 - - *228 - - &383 + - *230 + - *231 + - &386 name: environment_name in: path required: true @@ -62000,9 +62692,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *385 examples: - default: &386 + default: &389 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -62086,9 +62778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: false content: @@ -62098,7 +62790,7 @@ paths: - object - 'null' properties: - wait_timer: *384 + wait_timer: *387 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -62117,14 +62809,14 @@ paths: items: type: object properties: - type: *381 + type: *384 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *385 + deployment_branch_policy: *388 additionalProperties: false examples: default: @@ -62144,9 +62836,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *385 examples: - default: *386 + default: *389 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -62170,9 +62862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 responses: '204': description: Default response @@ -62197,9 +62889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 - *17 - *18 responses: @@ -62218,7 +62910,7 @@ paths: - 2 branch_policies: type: array - items: &387 + items: &390 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -62279,9 +62971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: true content: @@ -62329,9 +63021,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - example-wildcard: &388 + example-wildcard: &391 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -62373,10 +63065,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - &389 + - *230 + - *231 + - *386 + - &392 name: branch_policy_id in: path required: true @@ -62388,9 +63080,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62409,10 +63101,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - *389 + - *230 + - *231 + - *386 + - *392 requestBody: required: true content: @@ -62441,9 +63133,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62462,10 +63154,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - *389 + - *230 + - *231 + - *386 + - *392 responses: '204': description: Response @@ -62490,9 +63182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 responses: '200': description: List of deployment protection rules @@ -62509,7 +63201,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &390 + items: &393 title: Deployment protection rule description: Deployment protection rule type: object @@ -62531,7 +63223,7 @@ paths: for the environment. examples: - true - app: &391 + app: &394 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -62634,9 +63326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 requestBody: content: application/json: @@ -62657,9 +63349,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *390 + schema: *393 examples: - default: &392 + default: &395 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -62694,9 +63386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 - *18 - *17 responses: @@ -62716,7 +63408,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *391 + items: *394 examples: default: value: @@ -62751,10 +63443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *227 - - *228 - - *383 - - &393 + - *230 + - *231 + - *386 + - &396 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -62766,9 +63458,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *393 examples: - default: *392 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62789,10 +63481,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *383 - - *228 - - *227 - - *393 + - *386 + - *231 + - *230 + - *396 responses: '204': description: Response @@ -62818,9 +63510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 - *17 - *18 responses: @@ -62838,9 +63530,9 @@ paths: type: integer secrets: type: array - items: *273 + items: *276 examples: - default: *274 + default: *277 headers: Link: *37 x-github: @@ -62865,17 +63557,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62897,18 +63589,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *394 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62930,10 +63622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 requestBody: required: true content: @@ -62964,7 +63656,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -62990,10 +63682,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 responses: '204': description: Default response @@ -63018,10 +63710,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *227 - - *228 - - *383 - - *249 + - *230 + - *231 + - *386 + - *252 - *18 responses: '200': @@ -63038,9 +63730,9 @@ paths: type: integer variables: type: array - items: *277 + items: *280 examples: - default: *278 + default: *281 headers: Link: *37 x-github: @@ -63063,9 +63755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: true content: @@ -63092,7 +63784,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -63117,18 +63809,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *227 - - *228 - - *383 - - *116 + - *230 + - *231 + - *386 + - *119 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: *395 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63149,10 +63841,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *227 - - *228 - - *116 - - *383 + - *230 + - *231 + - *119 + - *386 requestBody: required: true content: @@ -63194,10 +63886,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *227 - - *228 - - *116 - - *383 + - *230 + - *231 + - *119 + - *386 responses: '204': description: Response @@ -63219,8 +63911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -63230,7 +63922,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: 200-response: value: @@ -63297,8 +63989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *227 - - *228 + - *230 + - *231 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -63320,7 +64012,7 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: default: value: @@ -63457,8 +64149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -63491,9 +64183,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 '400': *14 '422': *15 '403': *27 @@ -63514,8 +64206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -63566,7 +64258,7 @@ paths: schema: type: string '404': *6 - '409': *125 + '409': *128 '403': *27 '422': description: Validation failed @@ -63574,8 +64266,8 @@ paths: application/json: schema: oneOf: - - *89 - - *396 + - *92 + - *399 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63600,8 +64292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *227 - - *228 + - *230 + - *231 - name: file_sha in: path required: true @@ -63653,7 +64345,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63700,8 +64392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -63810,7 +64502,7 @@ paths: description: Response content: application/json: - schema: &397 + schema: &400 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -63981,7 +64673,7 @@ paths: type: string '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64030,15 +64722,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 responses: '200': description: Response content: application/json: - schema: *397 + schema: *400 examples: default: value: @@ -64068,7 +64760,7 @@ paths: signature: payload: '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64093,9 +64785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *227 - - *228 - - &398 + - *230 + - *231 + - &401 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. @@ -64112,7 +64804,7 @@ paths: application/json: schema: type: array - items: &399 + items: &402 title: Git Reference description: Git references within a repository type: object @@ -64167,7 +64859,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64188,17 +64880,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 responses: '200': description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: &400 + default: &403 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -64208,7 +64900,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64227,8 +64919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64257,16 +64949,16 @@ paths: description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: *400 + default: *403 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64285,9 +64977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 requestBody: required: true content: @@ -64316,11 +65008,11 @@ paths: description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: *400 + default: *403 '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64336,14 +65028,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 responses: '204': description: Response '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64390,8 +65082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64458,7 +65150,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &405 title: Git Tag description: Metadata for a Git tag type: object @@ -64514,7 +65206,7 @@ paths: - sha - type - url - verification: *401 + verification: *404 required: - sha - url @@ -64524,7 +65216,7 @@ paths: - tag - message examples: - default: &403 + default: &406 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -64550,7 +65242,7 @@ paths: schema: type: string '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64595,8 +65287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *227 - - *228 + - *230 + - *231 - name: tag_sha in: path required: true @@ -64607,11 +65299,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: - default: *403 + default: *406 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64633,8 +65325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64708,7 +65400,7 @@ paths: description: Response content: application/json: - schema: &404 + schema: &407 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -64803,7 +65495,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64826,8 +65518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *227 - - *228 + - *230 + - *231 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -64850,7 +65542,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *407 examples: default-response: summary: Default response @@ -64891,7 +65583,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64909,8 +65601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -64920,7 +65612,7 @@ paths: application/json: schema: type: array - items: &405 + items: &408 title: Webhook description: Webhooks for repositories. type: object @@ -64983,7 +65675,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &614 + last_response: &617 title: Hook Response type: object properties: @@ -65060,8 +65752,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -65114,9 +65806,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: &406 + default: &409 value: type: Repository id: 12345678 @@ -65164,17 +65856,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '200': description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 '404': *6 x-github: githubCloudOnly: false @@ -65194,9 +65886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 requestBody: required: true content: @@ -65241,9 +65933,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 '422': *15 '404': *6 x-github: @@ -65261,9 +65953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65287,9 +65979,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '200': description: Response @@ -65316,9 +66008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 requestBody: required: false content: @@ -65362,11 +66054,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *17 - - *147 + - *150 - name: redelivery in: query required: false @@ -65379,9 +66071,9 @@ paths: application/json: schema: type: array - items: *148 + items: *151 examples: - default: *149 + default: *152 '400': *14 '422': *15 x-github: @@ -65400,18 +66092,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *16 responses: '200': description: Response content: application/json: - schema: *150 + schema: *153 examples: - default: *151 + default: *154 '400': *14 '422': *15 x-github: @@ -65430,12 +66122,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *16 responses: - '202': *91 + '202': *94 '400': *14 '422': *15 x-github: @@ -65455,9 +66147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65482,9 +66174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65542,14 +66234,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &407 + schema: &410 title: Import description: A repository import from an external source. type: object @@ -65656,7 +66348,7 @@ paths: - html_url - authors_url examples: - default: &410 + default: &413 value: vcs: subversion use_lfs: true @@ -65672,7 +66364,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': &408 + '503': &411 description: Unavailable due to service under maintenance. content: application/json: @@ -65701,8 +66393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -65750,7 +66442,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: default: value: @@ -65775,7 +66467,7 @@ paths: type: string '422': *15 '404': *6 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65803,8 +66495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -65856,7 +66548,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: example-1: summary: Example 1 @@ -65904,7 +66596,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': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65927,12 +66619,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65958,9 +66650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *227 - - *228 - - &564 + - *230 + - *231 + - &567 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -65974,7 +66666,7 @@ paths: application/json: schema: type: array - items: &409 + items: &412 title: Porter Author description: Porter Author type: object @@ -66028,7 +66720,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': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66053,8 +66745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *227 - - *228 + - *230 + - *231 - name: author_id in: path required: true @@ -66084,7 +66776,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *412 examples: default: value: @@ -66097,7 +66789,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66121,8 +66813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66163,7 +66855,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66191,8 +66883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -66219,11 +66911,11 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: *410 + default: *413 '422': *15 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66246,8 +66938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66255,8 +66947,8 @@ paths: application/json: schema: *20 examples: - default: *411 - '301': *239 + default: *414 + '301': *242 '404': *6 x-github: githubCloudOnly: false @@ -66276,8 +66968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66285,12 +66977,12 @@ paths: application/json: schema: anyOf: - - *153 + - *156 - type: object properties: {} additionalProperties: false examples: - default: &413 + default: &416 value: limit: collaborators_only origin: repository @@ -66315,13 +67007,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: application/json: - schema: *412 + schema: *415 examples: default: summary: Example request body @@ -66333,9 +67025,9 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: - default: *413 + default: *416 '409': description: Response x-github: @@ -66357,8 +67049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -66381,8 +67073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -66392,9 +67084,9 @@ paths: application/json: schema: type: array - items: *414 + items: *417 examples: - default: &557 + default: &560 value: - id: 1 repository: @@ -66525,9 +67217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *227 - - *228 - - *157 + - *230 + - *231 + - *160 requestBody: required: false content: @@ -66556,7 +67248,7 @@ paths: description: Response content: application/json: - schema: *414 + schema: *417 examples: default: value: @@ -66687,9 +67379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *227 - - *228 - - *157 + - *230 + - *231 + - *160 responses: '204': description: Response @@ -66720,8 +67412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -66761,7 +67453,7 @@ paths: required: false schema: type: string - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -66774,7 +67466,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -66784,7 +67476,7 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: default: value: @@ -66934,7 +67626,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *239 + '301': *242 '422': *15 '404': *6 x-github: @@ -66963,8 +67655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -67045,9 +67737,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: &418 + default: &421 value: id: 1 node_id: MDU6SXNzdWUx @@ -67201,9 +67893,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *57 + '503': *60 '404': *6 - '410': *236 + '410': *239 x-github: triggersNotification: true githubCloudOnly: false @@ -67231,9 +67923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *227 - - *228 - - *78 + - *230 + - *231 + - *81 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -67243,7 +67935,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -67253,9 +67945,9 @@ paths: application/json: schema: type: array - items: *415 + items: *418 examples: - default: &420 + default: &423 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67313,17 +68005,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: &416 + default: &419 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67377,9 +68069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -67401,9 +68093,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: *416 + default: *419 '422': *15 x-github: githubCloudOnly: false @@ -67421,9 +68113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -67443,9 +68135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -67471,9 +68163,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -67494,9 +68186,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -67528,16 +68220,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -67559,10 +68251,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -67582,8 +68274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -67593,7 +68285,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Issue Event description: Issue Event type: object @@ -67640,7 +68332,7 @@ paths: issue: anyOf: - type: 'null' - - *69 + - *72 label: title: Issue Event Label description: Issue Event Label @@ -67673,7 +68365,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *158 + requested_team: *161 dismissed_review: title: Issue Event Dismissed Review type: object @@ -67740,7 +68432,7 @@ paths: required: - from - to - author_association: *55 + author_association: *58 lock_reason: type: - string @@ -67932,8 +68624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *227 - - *228 + - *230 + - *231 - name: event_id in: path required: true @@ -67944,7 +68636,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: default: value: @@ -68137,7 +68829,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *236 + '410': *239 '403': *27 x-github: githubCloudOnly: false @@ -68171,9 +68863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *227 - - *228 - - &419 + - *230 + - *231 + - &422 name: issue_number description: The number that identifies the issue. in: path @@ -68185,12 +68877,12 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 - '301': *239 + default: *421 + '301': *242 '404': *6 - '410': *236 + '410': *239 '304': *35 x-github: githubCloudOnly: false @@ -68215,9 +68907,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -68325,15 +69017,15 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 '422': *15 - '503': *57 + '503': *60 '403': *27 - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68351,9 +69043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -68379,9 +69071,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68397,9 +69089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: content: application/json: @@ -68424,9 +69116,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68448,9 +69140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - name: assignee in: path required: true @@ -68490,10 +69182,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *227 - - *228 - - *419 - - *59 + - *230 + - *231 + - *422 + - *62 - *17 - *18 responses: @@ -68503,13 +69195,13 @@ paths: application/json: schema: type: array - items: *415 + items: *418 examples: - default: *420 + default: *423 headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68538,9 +69230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: true content: @@ -68562,16 +69254,16 @@ paths: description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: *416 + default: *419 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *236 + '410': *239 '422': *15 '404': *6 x-github: @@ -68591,9 +69283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -68607,7 +69299,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &423 + - &426 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -68656,7 +69348,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &424 + - &427 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -68784,7 +69476,7 @@ paths: - performed_via_github_app - assignee - assigner - - &425 + - &428 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -68830,7 +69522,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &426 + - &429 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -68876,7 +69568,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &427 + - &430 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -68925,7 +69617,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &428 + - &431 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -68954,7 +69646,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *158 + requested_team: *161 requested_reviewer: *4 required: - review_requester @@ -68967,7 +69659,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &429 + - &432 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -68996,7 +69688,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *158 + requested_team: *161 requested_reviewer: *4 required: - review_requester @@ -69009,7 +69701,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &430 + - &433 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -69065,7 +69757,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &431 + - &434 title: Locked Issue Event description: Locked Issue Event type: object @@ -69110,7 +69802,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &432 + - &435 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -69171,7 +69863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &433 + - &436 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -69232,7 +69924,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &434 + - &437 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -69293,7 +69985,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &435 + - &438 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -69386,7 +70078,7 @@ paths: color: red headers: Link: *37 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69403,9 +70095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -69415,7 +70107,7 @@ paths: application/json: schema: type: array - items: &421 + items: &424 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -69470,7 +70162,7 @@ paths: - color - default examples: - default: &422 + default: &425 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69488,9 +70180,9 @@ paths: default: false headers: Link: *37 - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69507,9 +70199,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69568,12 +70260,12 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 - '301': *239 + default: *425 + '301': *242 '404': *6 - '410': *236 + '410': *239 '422': *15 x-github: githubCloudOnly: false @@ -69590,9 +70282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69652,12 +70344,12 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 - '301': *239 + default: *425 + '301': *242 '404': *6 - '410': *236 + '410': *239 '422': *15 x-github: githubCloudOnly: false @@ -69674,15 +70366,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 responses: '204': description: Response - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69701,9 +70393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - name: name in: path required: true @@ -69716,7 +70408,7 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: default: value: @@ -69727,9 +70419,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69749,9 +70441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69780,7 +70472,7 @@ paths: '204': description: Response '403': *27 - '410': *236 + '410': *239 '404': *6 '422': *15 x-github: @@ -69798,9 +70490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 responses: '204': description: Response @@ -69822,9 +70514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - 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. @@ -69850,13 +70542,13 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69874,9 +70566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: true content: @@ -69908,16 +70600,16 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -69939,10 +70631,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *227 - - *228 - - *419 - - *223 + - *230 + - *231 + - *422 + - *226 responses: '204': description: Response @@ -69962,9 +70654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -69979,9 +70671,6 @@ paths: description: Timeline Event type: object anyOf: - - *423 - - *424 - - *425 - *426 - *427 - *428 @@ -69992,6 +70681,9 @@ paths: - *433 - *434 - *435 + - *436 + - *437 + - *438 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -70039,12 +70731,12 @@ paths: issue_url: type: string format: uri - author_association: *55 + author_association: *58 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - event - actor @@ -70075,7 +70767,7 @@ paths: properties: type: type: string - issue: *69 + issue: *72 required: - event - created_at @@ -70287,7 +70979,7 @@ paths: type: string body_text: type: string - author_association: *55 + author_association: *58 required: - event - id @@ -70310,7 +71002,7 @@ paths: type: string comments: type: array - items: &455 + items: &458 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -70415,7 +71107,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *55 + author_association: *58 _links: type: object properties: @@ -70510,7 +71202,7 @@ paths: enum: - line - file - reactions: *56 + reactions: *59 body_html: type: string examples: @@ -70548,7 +71240,7 @@ paths: type: string comments: type: array - items: *351 + items: *354 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -70823,7 +71515,7 @@ paths: headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70840,8 +71532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -70851,7 +71543,7 @@ paths: application/json: schema: type: array - items: &436 + items: &439 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -70915,8 +71607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -70952,9 +71644,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *439 examples: - default: &437 + default: &440 value: id: 1 key: ssh-rsa AAA... @@ -70987,9 +71679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *227 - - *228 - - &438 + - *230 + - *231 + - &441 name: key_id description: The unique identifier of the key. in: path @@ -71001,9 +71693,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *439 examples: - default: *437 + default: *440 '404': *6 x-github: githubCloudOnly: false @@ -71021,9 +71713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *227 - - *228 - - *438 + - *230 + - *231 + - *441 responses: '204': description: Response @@ -71043,8 +71735,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -71054,9 +71746,9 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 + default: *425 headers: Link: *37 '404': *6 @@ -71077,8 +71769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71114,9 +71806,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: &439 + default: &442 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71148,8 +71840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71160,9 +71852,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *439 + default: *442 '404': *6 x-github: githubCloudOnly: false @@ -71179,8 +71871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71219,7 +71911,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: default: value: @@ -71245,8 +71937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71272,8 +71964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -71312,9 +72004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *227 - - *228 - - *328 + - *230 + - *231 + - *331 responses: '200': description: Response @@ -71380,7 +72072,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 required: - _links - git_url @@ -71461,8 +72153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71527,8 +72219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71562,9 +72254,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *352 + schema: *355 examples: - default: *440 + default: *443 '204': description: Response when already merged '404': @@ -71589,8 +72281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -71631,7 +72323,7 @@ paths: application/json: schema: type: array - items: *356 + items: *359 examples: default: value: @@ -71687,8 +72379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71728,9 +72420,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: &441 + default: &444 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -71789,9 +72481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *227 - - *228 - - &442 + - *230 + - *231 + - &445 name: milestone_number description: The number that identifies the milestone. in: path @@ -71803,9 +72495,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: *441 + default: *444 '404': *6 x-github: githubCloudOnly: false @@ -71822,9 +72514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 requestBody: required: false content: @@ -71862,9 +72554,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: *441 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71880,9 +72572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 responses: '204': description: Response @@ -71903,9 +72595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 - *17 - *18 responses: @@ -71915,9 +72607,9 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 + default: *425 headers: Link: *37 x-github: @@ -71936,12 +72628,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *227 - - *228 - - *443 - - *444 - - *59 - - *445 + - *230 + - *231 + - *446 + - *447 + - *62 + - *448 - *17 - *18 responses: @@ -71951,9 +72643,9 @@ paths: application/json: schema: type: array - items: *81 + items: *84 examples: - default: *446 + default: *449 headers: Link: *37 x-github: @@ -71977,8 +72669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -72036,14 +72728,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &447 + schema: &450 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -72187,7 +72879,7 @@ paths: - custom_404 - public examples: - default: &448 + default: &451 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -72228,8 +72920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72284,11 +72976,11 @@ paths: description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72309,8 +73001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72389,7 +73081,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72410,14 +73102,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72437,8 +73129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -72448,7 +73140,7 @@ paths: application/json: schema: type: array - items: &449 + items: &452 title: Page Build description: Page Build type: object @@ -72540,8 +73232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response @@ -72588,16 +73280,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &450 + default: &453 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -72645,8 +73337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *227 - - *228 + - *230 + - *231 - name: build_id in: path required: true @@ -72657,9 +73349,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72679,8 +73371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72789,9 +73481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *227 - - *228 - - &451 + - *230 + - *231 + - &454 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -72849,11 +73541,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *227 - - *228 - - *451 + - *230 + - *231 + - *454 responses: - '204': *128 + '204': *131 '404': *6 x-github: githubCloudOnly: false @@ -72878,8 +73570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -73147,7 +73839,7 @@ paths: description: Empty response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -73174,8 +73866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Private vulnerability reporting status @@ -73212,10 +73904,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: - '204': *128 + '204': *131 '422': *14 x-github: githubCloudOnly: false @@ -73234,10 +73926,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: - '204': *128 + '204': *131 '422': *14 x-github: githubCloudOnly: false @@ -73258,8 +73950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: Indicates the state of the projects to return. in: query @@ -73280,7 +73972,7 @@ paths: application/json: schema: type: array - items: *187 + items: *190 examples: default: value: @@ -73320,7 +74012,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -73340,8 +74032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73367,13 +74059,13 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *235 + default: *238 '401': *23 '403': *27 '404': *6 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -73393,8 +74085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -73402,7 +74094,7 @@ paths: application/json: schema: type: array - items: *192 + items: *195 examples: default: value: @@ -73433,8 +74125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73446,7 +74138,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *192 + items: *195 required: - properties examples: @@ -73496,8 +74188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -73557,9 +74249,9 @@ paths: application/json: schema: type: array - items: *452 + items: *455 examples: - default: *453 + default: *456 headers: Link: *37 '304': *35 @@ -73591,8 +74283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73659,7 +74351,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &460 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -73788,7 +74480,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 active_lock_reason: type: - string @@ -73843,7 +74535,7 @@ paths: type: - array - 'null' - items: *172 + items: *175 head: type: object properties: @@ -73851,7 +74543,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: *4 @@ -73868,7 +74560,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: *4 @@ -73881,14 +74573,14 @@ paths: _links: type: object properties: - comments: *357 - commits: *357 - statuses: *357 - html: *357 - issue: *357 - review_comments: *357 - review_comment: *357 - self: *357 + comments: *360 + commits: *360 + statuses: *360 + html: *360 + issue: *360 + review_comments: *360 + review_comment: *360 + self: *360 required: - comments - commits @@ -73898,8 +74590,8 @@ paths: - review_comments - review_comment - self - author_association: *55 - auto_merge: *454 + author_association: *58 + auto_merge: *457 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -74001,7 +74693,7 @@ paths: - merged_by - review_comments examples: - default: &458 + default: &461 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -74528,8 +75220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: sort in: query required: false @@ -74548,7 +75240,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -74558,9 +75250,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: &460 + default: &463 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74637,17 +75329,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: &456 + default: &459 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74722,9 +75414,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -74746,9 +75438,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74764,9 +75456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -74787,9 +75479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -74815,9 +75507,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -74838,9 +75530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -74872,16 +75564,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -74903,10 +75595,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -74949,9 +75641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *227 - - *228 - - &459 + - *230 + - *231 + - &462 name: pull_number description: The number that identifies the pull request. in: path @@ -74964,9 +75656,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *457 + schema: *460 examples: - default: *458 + default: *461 '304': *35 '404': *6 '406': @@ -74975,7 +75667,7 @@ paths: application/json: schema: *3 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75001,9 +75693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75045,9 +75737,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *460 examples: - default: *458 + default: *461 '422': *15 '403': *27 x-github: @@ -75069,9 +75761,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -75132,21 +75824,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75172,10 +75864,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *227 - - *228 - - *459 - - *78 + - *230 + - *231 + - *462 + - *81 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -75185,7 +75877,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -75195,9 +75887,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *460 + default: *463 headers: Link: *37 x-github: @@ -75230,9 +75922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -75338,7 +76030,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: example-for-a-multi-line-comment: value: @@ -75426,10 +76118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *227 - - *228 - - *459 - - *68 + - *230 + - *231 + - *462 + - *71 requestBody: required: true content: @@ -75451,7 +76143,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: default: value: @@ -75537,9 +76229,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -75549,9 +76241,9 @@ paths: application/json: schema: type: array - items: *352 + items: *355 examples: - default: *461 + default: *464 headers: Link: *37 x-github: @@ -75581,9 +76273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -75593,7 +76285,7 @@ paths: application/json: schema: type: array - items: *364 + items: *367 examples: default: value: @@ -75612,7 +76304,7 @@ paths: Link: *37 '422': *15 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75631,9 +76323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 responses: '204': description: Response if pull request has been merged @@ -75656,9 +76348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75770,9 +76462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 responses: '200': description: Response @@ -75788,7 +76480,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 required: - users - teams @@ -75847,9 +76539,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75886,7 +76578,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: default: value: @@ -76422,9 +77114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -76458,7 +77150,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: default: value: @@ -76963,9 +77655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -76975,7 +77667,7 @@ paths: application/json: schema: type: array - items: &462 + items: &465 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -77049,7 +77741,7 @@ paths: type: string body_text: type: string - author_association: *55 + author_association: *58 required: - id - node_id @@ -77131,9 +77823,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -77223,9 +77915,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &464 + default: &467 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77288,10 +77980,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - &463 + - *230 + - *231 + - *462 + - &466 name: review_id description: The unique identifier of the review. in: path @@ -77303,9 +77995,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &465 + default: &468 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77364,10 +78056,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77390,7 +78082,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -77452,18 +78144,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 responses: '200': description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *464 + default: *467 '422': *7 '404': *6 x-github: @@ -77490,10 +78182,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 - *17 - *18 responses: @@ -77587,13 +78279,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *55 + author_association: *58 _links: type: object properties: - self: *357 - html: *357 - pull_request: *357 + self: *360 + html: *360 + pull_request: *360 required: - self - html @@ -77602,7 +78294,7 @@ paths: type: string body_html: type: string - reactions: *56 + reactions: *59 side: description: The side of the first line of the range for a multi-line comment. @@ -77744,10 +78436,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77776,7 +78468,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -77839,10 +78531,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77877,9 +78569,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *465 + default: *468 '404': *6 '422': *7 '403': *27 @@ -77901,9 +78593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -77967,8 +78659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *227 - - *228 + - *230 + - *231 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -77981,9 +78673,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: &467 + default: &470 value: type: file encoding: base64 @@ -78025,8 +78717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *227 - - *228 + - *230 + - *231 - name: dir description: The alternate path to look for a README file in: path @@ -78046,9 +78738,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: *467 + default: *470 '404': *6 '422': *15 x-github: @@ -78070,8 +78762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -78081,7 +78773,7 @@ paths: application/json: schema: type: array - items: &468 + items: &471 title: Release description: A release. type: object @@ -78153,7 +78845,7 @@ paths: author: *4 assets: type: array - items: &469 + items: &472 title: Release Asset description: Data related to a release. type: object @@ -78223,7 +78915,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *56 + reactions: *59 required: - assets_url - upload_url @@ -78333,8 +79025,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -78410,9 +79102,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: &472 + default: &475 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -78513,9 +79205,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *227 - - *228 - - &470 + - *230 + - *231 + - &473 name: asset_id description: The unique identifier of the asset. in: path @@ -78527,9 +79219,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *472 examples: - default: &471 + default: &474 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 @@ -78563,7 +79255,7 @@ paths: type: User site_admin: false '404': *6 - '302': *366 + '302': *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78579,9 +79271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *227 - - *228 - - *470 + - *230 + - *231 + - *473 requestBody: required: false content: @@ -78610,9 +79302,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *472 examples: - default: *471 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78628,9 +79320,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *227 - - *228 - - *470 + - *230 + - *231 + - *473 responses: '204': description: Response @@ -78654,8 +79346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -78741,16 +79433,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78767,8 +79459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *227 - - *228 + - *230 + - *231 - name: tag description: tag parameter in: path @@ -78781,9 +79473,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 '404': *6 x-github: githubCloudOnly: false @@ -78805,9 +79497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *227 - - *228 - - &473 + - *230 + - *231 + - &476 name: release_id description: The unique identifier of the release. in: path @@ -78821,9 +79513,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: *468 + schema: *471 examples: - default: *472 + default: *475 '401': description: Unauthorized x-github: @@ -78841,9 +79533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 requestBody: required: false content: @@ -78907,9 +79599,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 '404': description: Not Found if the discussion category name is invalid content: @@ -78930,9 +79622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 responses: '204': description: Response @@ -78952,9 +79644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - *17 - *18 responses: @@ -78964,7 +79656,7 @@ paths: application/json: schema: type: array - items: *469 + items: *472 examples: default: value: @@ -79044,9 +79736,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: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - name: name in: query required: true @@ -79072,7 +79764,7 @@ paths: description: Response for successful upload content: application/json: - schema: *469 + schema: *472 examples: response-for-successful-upload: value: @@ -79126,9 +79818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - 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. @@ -79152,9 +79844,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -79175,9 +79867,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 requestBody: required: true content: @@ -79207,16 +79899,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -79238,10 +79930,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *227 - - *228 - - *473 - - *223 + - *230 + - *231 + - *476 + - *226 responses: '204': description: Response @@ -79265,9 +79957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 - *17 - *18 responses: @@ -79283,8 +79975,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *474 - - &476 + - *477 + - &479 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -79303,54 +79995,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *475 - - *476 - - allOf: - - *477 - - *476 - allOf: - *478 - - *476 - - allOf: - *479 - - *476 - allOf: - *480 - - *476 + - *479 - allOf: - *481 - - *476 + - *479 - allOf: - *482 - - *476 + - *479 - allOf: - *483 - - *476 + - *479 - allOf: - *484 - - *476 + - *479 - allOf: - *485 - - *476 + - *479 - allOf: - *486 - - *476 + - *479 - allOf: - *487 - - *476 + - *479 - allOf: - *488 - - *476 + - *479 - allOf: - *489 - - *476 + - *479 - allOf: - *490 - - *476 + - *479 - allOf: - *491 - - *476 + - *479 + - allOf: + - *492 + - *479 + - allOf: + - *493 + - *479 + - allOf: + - *494 + - *479 examples: default: value: @@ -79389,8 +80081,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - name: includes_parents @@ -79401,7 +80093,7 @@ paths: schema: type: boolean default: true - - *492 + - *495 responses: '200': description: Response @@ -79409,7 +80101,7 @@ paths: application/json: schema: type: array - items: *200 + items: *203 examples: default: value: @@ -79456,8 +80148,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 requestBody: description: Request body required: true @@ -79477,16 +80169,16 @@ paths: - tag - push default: branch - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *194 + items: *200 + conditions: *197 rules: type: array description: An array of rules within the ruleset. - items: *199 + items: *202 required: - name - enforcement @@ -79517,9 +80209,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: &502 + default: &505 value: id: 42 name: super cool ruleset @@ -79566,12 +80258,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *227 - - *228 - - *493 - - *494 - - *495 + - *230 + - *231 - *496 + - *497 + - *498 + - *499 - *17 - *18 responses: @@ -79579,9 +80271,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: *498 + default: *501 '404': *6 '500': *39 x-github: @@ -79602,17 +80294,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *227 - - *228 - - *499 + - *230 + - *231 + - *502 responses: '200': description: Response content: application/json: - schema: *500 + schema: *503 examples: - default: *501 + default: *504 '404': *6 '500': *39 x-github: @@ -79640,8 +80332,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79661,9 +80353,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *502 + default: *505 '404': *6 '500': *39 put: @@ -79681,8 +80373,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79707,16 +80399,16 @@ paths: - branch - tag - push - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *194 + items: *200 + conditions: *197 rules: description: An array of rules within the ruleset. type: array - items: *199 + items: *202 examples: default: value: @@ -79744,9 +80436,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *502 + default: *505 '404': *6 '500': *39 delete: @@ -79764,8 +80456,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79793,20 +80485,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *227 - - *228 - - *202 - - *203 - - *204 + - *230 + - *231 - *205 - - *40 - - *18 - - *17 - - *503 - - *504 - *206 - *207 - *208 + - *40 + - *18 + - *17 + - *506 + - *507 + - *209 + - *210 + - *211 responses: '200': description: Response @@ -79814,7 +80506,7 @@ paths: application/json: schema: type: array - items: &507 + items: &510 type: object properties: number: *46 @@ -79830,8 +80522,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *505 - resolution: *506 + state: *508 + resolution: *509 resolved_at: type: - string @@ -79974,7 +80666,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79996,15 +80688,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 responses: '200': description: Response content: application/json: - schema: *507 + schema: *510 examples: default: value: @@ -80031,7 +80723,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80052,9 +80744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 requestBody: required: true content: @@ -80062,8 +80754,8 @@ paths: schema: type: object properties: - state: *505 - resolution: *506 + state: *508 + resolution: *509 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -80082,7 +80774,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: default: value: @@ -80131,7 +80823,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80153,9 +80845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 - *18 - *17 responses: @@ -80166,7 +80858,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &635 + items: &638 type: object properties: type: @@ -80523,7 +81215,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80545,8 +81237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -80554,14 +81246,14 @@ paths: schema: type: object properties: - reason: &509 + reason: &512 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *508 + placeholder_id: *511 required: - reason - placeholder_id @@ -80578,7 +81270,7 @@ paths: schema: type: object properties: - reason: *509 + reason: *512 expire_at: type: - string @@ -80602,7 +81294,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80624,8 +81316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *227 - - *228 + - *230 + - *231 - *40 - name: sort description: The property to sort the results by. @@ -80669,9 +81361,9 @@ paths: application/json: schema: type: array - items: *510 + items: *513 examples: - default: *511 + default: *514 '400': *14 '404': *6 x-github: @@ -80694,8 +81386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -80775,7 +81467,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 required: - login - type @@ -80865,9 +81557,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: &513 + default: &516 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81100,8 +81792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -81214,7 +81906,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: default: value: @@ -81361,17 +82053,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: '200': description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *513 + default: *516 '403': *27 '404': *6 x-github: @@ -81395,9 +82087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 requestBody: required: true content: @@ -81477,7 +82169,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 required: - login - type @@ -81568,17 +82260,17 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *513 - add_credit: *513 + default: *516 + add_credit: *516 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *89 + schema: *92 examples: invalid_state_transition: value: @@ -81609,11 +82301,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: - '202': *91 + '202': *94 '400': *14 '403': *27 '404': *6 @@ -81638,17 +82330,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: '202': description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 '400': *14 '422': *15 '403': *27 @@ -81674,8 +82366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -81771,8 +82463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -81781,7 +82473,7 @@ paths: application/json: schema: type: array - items: &514 + items: &517 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -81793,8 +82485,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *91 - '204': *128 + '202': *94 + '204': *131 '422': description: Repository contains more than 10,000 commits x-github: @@ -81814,8 +82506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -81865,8 +82557,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *91 - '204': *128 + '202': *94 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81893,8 +82585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -81965,8 +82657,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *91 - '204': *128 + '202': *94 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81988,8 +82680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -82143,8 +82835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -82154,7 +82846,7 @@ paths: application/json: schema: type: array - items: *514 + items: *517 examples: default: value: @@ -82167,7 +82859,7 @@ paths: - - 0 - 2 - 21 - '204': *128 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82187,8 +82879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *227 - - *228 + - *230 + - *231 - name: sha in: path required: true @@ -82244,7 +82936,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *518 examples: default: value: @@ -82298,8 +82990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82311,7 +83003,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -82331,14 +83023,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &516 + schema: &519 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82411,8 +83103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -82438,7 +83130,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *519 examples: default: value: @@ -82465,8 +83157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -82486,8 +83178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82569,8 +83261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -82578,7 +83270,7 @@ paths: application/json: schema: type: array - items: &517 + items: &520 title: Tag protection description: Tag protection type: object @@ -82635,8 +83327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -82659,7 +83351,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *520 examples: default: value: @@ -82690,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -82728,8 +83420,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *227 - - *228 + - *230 + - *231 - name: ref in: path required: true @@ -82765,8 +83457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82776,9 +83468,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 headers: Link: *37 '404': *6 @@ -82798,8 +83490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 responses: @@ -82807,7 +83499,7 @@ paths: description: Response content: application/json: - schema: &518 + schema: &521 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -82819,7 +83511,7 @@ paths: required: - names examples: - default: &519 + default: &522 value: names: - octocat @@ -82842,8 +83534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -82874,9 +83566,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: *519 + default: *522 '404': *6 '422': *7 x-github: @@ -82897,9 +83589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *227 - - *228 - - &520 + - *230 + - *231 + - &523 name: per description: The time frame to display results for. in: query @@ -82930,7 +83622,7 @@ paths: - 128 clones: type: array - items: &521 + items: &524 title: Traffic type: object properties: @@ -83017,8 +83709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -83112,8 +83804,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -83176,9 +83868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *227 - - *228 - - *520 + - *230 + - *231 + - *523 responses: '200': description: Response @@ -83199,7 +83891,7 @@ paths: - 3782 views: type: array - items: *521 + items: *524 required: - uniques - count @@ -83276,8 +83968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -83313,7 +84005,7 @@ paths: description: Response content: application/json: - schema: *105 + schema: *108 examples: default: value: @@ -83551,8 +84243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -83575,8 +84267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -83598,8 +84290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -83625,8 +84317,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *227 - - *228 + - *230 + - *231 - name: ref in: path required: true @@ -83718,9 +84410,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -83761,7 +84453,7 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: default: value: @@ -83950,7 +84642,7 @@ paths: html_url: type: string format: uri - repository: *105 + repository: *108 score: type: number file_size: @@ -83969,7 +84661,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &522 + text_matches: &525 title: Search Result Text Matches type: array items: @@ -84084,7 +84776,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *57 + '503': *60 '422': *15 '403': *27 x-github: @@ -84132,7 +84824,7 @@ paths: enum: - author-date - committer-date - - &523 + - &526 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 @@ -84201,7 +84893,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 comment_count: type: integer message: @@ -84220,7 +84912,7 @@ paths: url: type: string format: uri - verification: *401 + verification: *404 required: - author - committer @@ -84235,7 +84927,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 parents: type: array items: @@ -84247,12 +84939,12 @@ paths: type: string sha: type: string - repository: *105 + repository: *108 score: type: number node_id: type: string - text_matches: *522 + text_matches: *525 required: - sha - node_id @@ -84444,7 +85136,7 @@ paths: - interactions - created - updated - - *523 + - *526 - *17 - *18 responses: @@ -84546,7 +85238,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 comments: type: integer created_at: @@ -84560,7 +85252,7 @@ paths: - string - 'null' format: date-time - text_matches: *522 + text_matches: *525 pull_request: type: object properties: @@ -84598,10 +85290,10 @@ paths: type: string score: type: number - author_association: *55 + author_association: *58 draft: type: boolean - repository: *54 + repository: *57 body_html: type: string body_text: @@ -84613,7 +85305,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - assignee - closed_at @@ -84729,7 +85421,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *57 + '503': *60 '422': *15 '304': *35 '403': *27 @@ -84782,7 +85474,7 @@ paths: enum: - created - updated - - *523 + - *526 - *17 - *18 responses: @@ -84827,7 +85519,7 @@ paths: - 'null' score: type: number - text_matches: *522 + text_matches: *525 required: - id - node_id @@ -84912,7 +85604,7 @@ paths: - forks - help-wanted-issues - updated - - *523 + - *526 - *17 - *18 responses: @@ -85131,7 +85823,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 permissions: type: object properties: @@ -85149,7 +85841,7 @@ paths: - admin - pull - push - text_matches: *522 + text_matches: *525 temp_clone_token: type: string allow_merge_commit: @@ -85352,7 +86044,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *57 + '503': *60 '422': *15 '304': *35 x-github: @@ -85457,7 +86149,7 @@ paths: - string - 'null' format: uri - text_matches: *522 + text_matches: *525 related: type: - array @@ -85650,7 +86342,7 @@ paths: - followers - repositories - joined - - *523 + - *526 - *17 - *18 responses: @@ -85760,7 +86452,7 @@ paths: type: - boolean - 'null' - text_matches: *522 + text_matches: *525 blog: type: - string @@ -85822,7 +86514,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *57 + '503': *60 '422': *15 x-github: githubCloudOnly: false @@ -85842,7 +86534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &524 + - &527 name: team_id description: The unique identifier of the team. in: path @@ -85854,9 +86546,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -85883,7 +86575,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *524 + - *527 requestBody: required: true content: @@ -85947,16 +86639,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '201': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 '422': *15 '403': *27 @@ -85984,7 +86676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *524 + - *527 responses: '204': description: Response @@ -86015,7 +86707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *524 + - *527 - *40 - *17 - *18 @@ -86026,9 +86718,9 @@ paths: application/json: schema: type: array - items: *214 + items: *217 examples: - default: *525 + default: *528 headers: Link: *37 x-github: @@ -86057,7 +86749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *524 + - *527 requestBody: required: true content: @@ -86091,9 +86783,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: triggersNotification: true githubCloudOnly: false @@ -86120,16 +86812,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 responses: '200': description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86154,8 +86846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: false content: @@ -86178,9 +86870,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *526 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86205,8 +86897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 responses: '204': description: Response @@ -86235,8 +86927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *524 - - *216 + - *527 + - *219 - *40 - *17 - *18 @@ -86247,9 +86939,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *527 + default: *530 headers: Link: *37 x-github: @@ -86278,8 +86970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: true content: @@ -86301,9 +86993,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: triggersNotification: true githubCloudOnly: false @@ -86330,17 +87022,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86365,9 +87057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 requestBody: required: true content: @@ -86389,9 +87081,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *528 + default: *531 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86416,9 +87108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 responses: '204': description: Response @@ -86447,9 +87139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -86475,9 +87167,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -86506,9 +87198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 requestBody: required: true content: @@ -86540,9 +87232,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86568,8 +87260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -86595,9 +87287,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -86626,8 +87318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: true content: @@ -86659,9 +87351,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86685,7 +87377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -86695,9 +87387,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 x-github: @@ -86723,7 +87415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *524 + - *527 - name: role description: Filters members returned by their role in the team. in: query @@ -86746,7 +87438,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -86774,8 +87466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: if user is a member @@ -86811,8 +87503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -86851,8 +87543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -86888,16 +87580,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '200': description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-user-is-a-team-maintainer: *529 + response-if-user-is-a-team-maintainer: *532 '404': *6 x-github: githubCloudOnly: false @@ -86930,8 +87622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 requestBody: required: false content: @@ -86956,9 +87648,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-users-membership-with-team-is-now-pending: *530 + response-if-users-membership-with-team-is-now-pending: *533 '403': description: Forbidden if team synchronization is set up '422': @@ -86992,8 +87684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -87022,7 +87714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87032,9 +87724,9 @@ paths: application/json: schema: type: array - items: *225 + items: *228 examples: - default: *531 + default: *534 headers: Link: *37 '404': *6 @@ -87061,16 +87753,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *524 - - *226 + - *527 + - *229 responses: '200': description: Response content: application/json: - schema: *225 + schema: *228 examples: - default: *532 + default: *535 '404': description: Not Found if project is not managed by this team x-github: @@ -87095,8 +87787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *524 - - *226 + - *527 + - *229 requestBody: required: false content: @@ -87164,8 +87856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *524 - - *226 + - *527 + - *229 responses: '204': description: Response @@ -87192,7 +87884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87202,9 +87894,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '404': *6 @@ -87234,15 +87926,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *533 + schema: *536 examples: alternative-response-with-extra-repository-information: value: @@ -87393,9 +88085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 requestBody: required: false content: @@ -87445,9 +88137,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 responses: '204': description: Response @@ -87472,7 +88164,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87482,9 +88174,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - response-if-child-teams-exist: *534 + response-if-child-teams-exist: *537 headers: Link: *37 '404': *6 @@ -87517,7 +88209,7 @@ paths: application/json: schema: oneOf: - - &536 + - &539 title: Private User description: Private User type: object @@ -87767,7 +88459,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *535 + - *538 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -87927,7 +88619,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *539 examples: default: value: @@ -88006,7 +88698,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '304': *35 '404': *6 '403': *27 @@ -88029,7 +88721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: If the user is blocked @@ -88057,7 +88749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -88081,7 +88773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -88130,9 +88822,9 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: - default: *163 + default: *166 '304': *35 '500': *39 '401': *23 @@ -88271,21 +88963,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88325,7 +89017,7 @@ paths: type: integer secrets: type: array - items: &537 + items: &540 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -88367,7 +89059,7 @@ paths: - visibility - selected_repositories_url examples: - default: *345 + default: *348 headers: Link: *37 x-github: @@ -88439,13 +89131,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 responses: '200': description: Response content: application/json: - schema: *537 + schema: *540 examples: default: value: @@ -88475,7 +89167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 requestBody: required: true content: @@ -88520,7 +89212,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -88548,7 +89240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 responses: '204': description: Response @@ -88573,7 +89265,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *113 + - *116 responses: '200': description: Response @@ -88589,9 +89281,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *538 + default: *541 '401': *23 '403': *27 '404': *6 @@ -88616,7 +89308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *113 + - *116 requestBody: required: true content: @@ -88670,7 +89362,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *113 + - *116 - name: repository_id in: path required: true @@ -88703,7 +89395,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *113 + - *116 - name: repository_id in: path required: true @@ -88735,15 +89427,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '304': *35 '500': *39 '401': *23 @@ -88769,7 +89461,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 requestBody: required: false content: @@ -88799,9 +89491,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 @@ -88823,9 +89515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: - '202': *91 + '202': *94 '304': *35 '500': *39 '401': *23 @@ -88852,13 +89544,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '202': description: Response content: application/json: - schema: &539 + schema: &542 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -88911,7 +89603,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &540 + default: &543 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -88943,7 +89635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *164 + - *167 - name: export_id in: path required: true @@ -88956,9 +89648,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *542 examples: - default: *540 + default: *543 '404': *6 x-github: githubCloudOnly: false @@ -88979,7 +89671,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *164 + - *167 responses: '200': description: Response @@ -88995,9 +89687,9 @@ paths: type: integer machines: type: array - items: *344 + items: *347 examples: - default: *541 + default: *544 '304': *35 '500': *39 '401': *23 @@ -89026,7 +89718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *164 + - *167 requestBody: required: true content: @@ -89082,11 +89774,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *238 + repository: *241 machine: anyOf: - type: 'null' - - *344 + - *347 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -89883,15 +90575,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '304': *35 '500': *39 '400': *14 @@ -89903,7 +90595,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89923,15 +90615,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '500': *39 '401': *23 '403': *27 @@ -89961,9 +90653,9 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: &554 + default: &557 value: - id: 197 name: hello_docker @@ -90064,7 +90756,7 @@ paths: application/json: schema: type: array - items: &542 + items: &545 title: Email description: Email type: object @@ -90134,9 +90826,9 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: - default: &556 + default: &559 value: - email: octocat@github.com verified: true @@ -90213,7 +90905,7 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: default: value: @@ -90325,7 +91017,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '304': *35 @@ -90358,7 +91050,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '304': *35 @@ -90380,7 +91072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: if the person is followed by the authenticated user @@ -90410,7 +91102,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -90434,7 +91126,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -90470,7 +91162,7 @@ paths: application/json: schema: type: array - items: &543 + items: &546 title: GPG Key description: A unique encryption key type: object @@ -90615,7 +91307,7 @@ paths: - subkeys - revoked examples: - default: &567 + default: &570 value: - id: 3 name: Octocat's GPG Key @@ -90700,9 +91392,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *546 examples: - default: &544 + default: &547 value: id: 3 name: Octocat's GPG Key @@ -90759,7 +91451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &545 + - &548 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -90771,9 +91463,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *546 examples: - default: *544 + default: *547 '404': *6 '304': *35 '403': *27 @@ -90796,7 +91488,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *545 + - *548 responses: '204': description: Response @@ -90985,9 +91677,9 @@ paths: type: string repositories: type: array - items: *54 + items: *57 examples: - default: *546 + default: *549 headers: Link: *37 '404': *6 @@ -91012,7 +91704,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *96 + - *99 responses: '204': description: Response @@ -91038,7 +91730,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *96 + - *99 responses: '204': description: Response @@ -91072,12 +91764,12 @@ paths: application/json: schema: anyOf: - - *153 + - *156 - type: object properties: {} additionalProperties: false examples: - default: *154 + default: *157 '204': description: Response when there are no restrictions x-github: @@ -91101,7 +91793,7 @@ paths: required: true content: application/json: - schema: *412 + schema: *415 examples: default: value: @@ -91112,7 +91804,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: default: value: @@ -91193,7 +91885,7 @@ paths: - closed - all default: open - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -91206,7 +91898,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -91216,9 +91908,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: *160 + default: *163 headers: Link: *37 '404': *6 @@ -91251,7 +91943,7 @@ paths: application/json: schema: type: array - items: &547 + items: &550 title: Key description: Key type: object @@ -91349,9 +92041,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *550 examples: - default: &548 + default: &551 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91384,15 +92076,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *438 + - *441 responses: '200': description: Response content: application/json: - schema: *547 + schema: *550 examples: - default: *548 + default: *551 '404': *6 '304': *35 '403': *27 @@ -91415,7 +92107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *438 + - *441 responses: '204': description: Response @@ -91448,7 +92140,7 @@ paths: application/json: schema: type: array - items: &549 + items: &552 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -91516,7 +92208,7 @@ paths: - id - type - login - plan: *72 + plan: *75 required: - billing_cycle - next_billing_date @@ -91527,7 +92219,7 @@ paths: - account - plan examples: - default: &550 + default: &553 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -91589,9 +92281,9 @@ paths: application/json: schema: type: array - items: *549 + items: *552 examples: - default: *550 + default: *553 headers: Link: *37 '304': *35 @@ -91631,7 +92323,7 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: default: value: @@ -91733,13 +92425,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -91797,7 +92489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *86 + - *89 requestBody: required: true content: @@ -91822,7 +92514,7 @@ paths: description: Response content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -91890,7 +92582,7 @@ paths: application/json: schema: type: array - items: *167 + items: *170 examples: default: value: @@ -92152,7 +92844,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -92332,7 +93024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *168 + - *171 - name: exclude in: query required: false @@ -92345,7 +93037,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -92539,7 +93231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *168 + - *171 responses: '302': description: Response @@ -92565,7 +93257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *168 + - *171 responses: '204': description: Response @@ -92594,8 +93286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *168 - - *551 + - *171 + - *554 responses: '204': description: Response @@ -92619,7 +93311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *168 + - *171 - *17 - *18 responses: @@ -92629,9 +93321,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '404': *6 @@ -92666,9 +93358,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *552 + default: *555 headers: Link: *37 '304': *35 @@ -92710,7 +93402,7 @@ paths: - docker - nuget - container - - *553 + - *556 - *18 - *17 responses: @@ -92720,10 +93412,10 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 - '400': *555 + default: *557 + '400': *558 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92743,16 +93435,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: - default: &568 + default: &571 value: id: 40201 name: octo-name @@ -92865,8 +93557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 responses: '204': description: Response @@ -92896,8 +93588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 - name: token description: package token schema: @@ -92929,8 +93621,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: - - *176 - - *177 + - *179 + - *180 - *18 - *17 - name: state @@ -92950,7 +93642,7 @@ paths: application/json: schema: type: array - items: *178 + items: *181 examples: default: value: @@ -92999,15 +93691,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '200': description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -93043,9 +93735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '204': description: Response @@ -93075,9 +93767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '204': description: Response @@ -93135,7 +93827,7 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: default: value: @@ -93204,9 +93896,9 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: - default: *556 + default: *559 headers: Link: *37 '304': *35 @@ -93317,9 +94009,9 @@ paths: application/json: schema: type: array - items: *54 + items: *57 examples: - default: &563 + default: &566 summary: Default response value: - id: 1296269 @@ -93635,9 +94327,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93675,9 +94367,9 @@ paths: application/json: schema: type: array - items: *414 + items: *417 examples: - default: *557 + default: *560 headers: Link: *37 '304': *35 @@ -93700,12 +94392,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *157 + - *160 responses: '204': description: Response '403': *27 - '409': *125 + '409': *128 '404': *6 '304': *35 x-github: @@ -93723,11 +94415,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *157 + - *160 responses: '204': description: Response - '409': *125 + '409': *128 '304': *35 '404': *6 '403': *27 @@ -93756,7 +94448,7 @@ paths: application/json: schema: type: array - items: &558 + items: &561 title: Social account description: Social media account type: object @@ -93773,7 +94465,7 @@ paths: - provider - url examples: - default: &559 + default: &562 value: - provider: twitter url: https://twitter.com/github @@ -93836,9 +94528,9 @@ paths: application/json: schema: type: array - items: *558 + items: *561 examples: - default: *559 + default: *562 '422': *15 '304': *35 '404': *6 @@ -93926,7 +94618,7 @@ paths: application/json: schema: type: array - items: &560 + items: &563 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -93946,7 +94638,7 @@ paths: - title - created_at examples: - default: &575 + default: &578 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94013,9 +94705,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: &561 + default: &564 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94046,7 +94738,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: - - &562 + - &565 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -94058,9 +94750,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: *561 + default: *564 '404': *6 '304': *35 '403': *27 @@ -94083,7 +94775,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: - - *562 + - *565 responses: '204': description: Response @@ -94112,7 +94804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &576 + - &579 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 @@ -94135,13 +94827,13 @@ paths: application/json: schema: type: array - items: *54 + items: *57 examples: - default-response: *563 + default-response: *566 application/vnd.github.v3.star+json: schema: type: array - items: &577 + items: &580 title: Starred Repository description: Starred Repository type: object @@ -94149,7 +94841,7 @@ paths: starred_at: type: string format: date-time - repo: *54 + repo: *57 required: - starred_at - repo @@ -94297,8 +94989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response if this repository is starred by you @@ -94326,8 +95018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -94351,8 +95043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -94385,9 +95077,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '304': *35 @@ -94424,7 +95116,7 @@ paths: application/json: schema: type: array - items: *212 + items: *215 examples: default: value: @@ -94500,7 +95192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *74 + - *77 responses: '200': description: Response @@ -94508,10 +95200,10 @@ paths: application/json: schema: oneOf: - - *536 - - *535 + - *539 + - *538 examples: - default-response: &565 + default-response: &568 summary: Default response value: login: octocat @@ -94546,7 +95238,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &566 + response-with-git-hub-plan-information: &569 summary: Response with GitHub plan information value: login: octocat @@ -94606,7 +95298,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *564 + - *567 - *17 responses: '200': @@ -94617,7 +95309,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: example: ; rel="next" @@ -94645,7 +95337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *118 + - *121 responses: '200': description: Response @@ -94653,11 +95345,11 @@ paths: application/json: schema: oneOf: - - *536 - - *535 + - *539 + - *538 examples: - default-response: *565 - response-with-git-hub-plan-information: *566 + default-response: *568 + response-with-git-hub-plan-information: *569 '404': *6 x-github: githubCloudOnly: false @@ -94683,7 +95375,7 @@ paths: - *17 - *41 - *42 - - *118 + - *121 - name: subject_digest description: Subject Digest in: path @@ -94785,7 +95477,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -94811,7 +95503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *118 + - *121 responses: '200': description: Response @@ -94819,9 +95511,9 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 + default: *557 '403': *27 '401': *23 x-github: @@ -94844,7 +95536,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -94854,7 +95546,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -94925,8 +95617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *118 - - *86 + - *121 + - *89 - *17 - *18 responses: @@ -94936,7 +95628,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95015,7 +95707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95025,7 +95717,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95092,7 +95784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95104,7 +95796,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -95123,7 +95815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95135,7 +95827,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -95154,7 +95846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *118 + - *121 - name: target_user in: path required: true @@ -95181,8 +95873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *118 - - *59 + - *121 + - *62 - *17 - *18 responses: @@ -95192,9 +95884,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '422': *15 @@ -95215,7 +95907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95225,9 +95917,9 @@ paths: application/json: schema: type: array - items: *543 + items: *546 examples: - default: *567 + default: *570 headers: Link: *37 x-github: @@ -95251,7 +95943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *118 + - *121 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -95323,7 +96015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *118 + - *121 responses: '200': description: Response @@ -95331,7 +96023,7 @@ paths: application/json: schema: *20 examples: - default: *411 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95349,7 +96041,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95397,7 +96089,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95407,9 +96099,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *552 + default: *555 headers: Link: *37 x-github: @@ -95448,8 +96140,8 @@ paths: - docker - nuget - container - - *553 - - *118 + - *556 + - *121 - *18 - *17 responses: @@ -95459,12 +96151,12 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 + default: *557 '403': *27 '401': *23 - '400': *555 + '400': *558 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95484,17 +96176,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: - default: *568 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95515,9 +96207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '204': description: Response @@ -95549,9 +96241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 - name: token description: package token schema: @@ -95583,9 +96275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '200': description: Response @@ -95593,7 +96285,7 @@ paths: application/json: schema: type: array - items: *178 + items: *181 examples: default: value: @@ -95651,16 +96343,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *176 - - *177 - *179 - - *118 + - *180 + - *182 + - *121 responses: '200': description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -95695,10 +96387,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *176 - - *177 - - *118 - *179 + - *180 + - *121 + - *182 responses: '204': description: Response @@ -95730,10 +96422,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *176 - - *177 - - *118 - *179 + - *180 + - *121 + - *182 responses: '204': description: Response @@ -95756,7 +96448,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *118 + - *121 - name: state description: Indicates the state of the projects to return. in: query @@ -95777,7 +96469,7 @@ paths: application/json: schema: type: array - items: *187 + items: *190 examples: default: value: @@ -95836,7 +96528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95846,7 +96538,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95925,7 +96617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95935,7 +96627,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -96012,7 +96704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *118 + - *121 - name: type description: Limit results to repositories of the specified type. in: query @@ -96055,9 +96747,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -96081,15 +96773,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *569 + schema: *572 examples: - default: *570 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96111,15 +96803,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *571 + schema: *574 examples: - default: *572 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96141,15 +96833,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *574 + default: *577 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96167,7 +96859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96177,9 +96869,9 @@ paths: application/json: schema: type: array - items: *558 + items: *561 examples: - default: *559 + default: *562 headers: Link: *37 x-github: @@ -96199,7 +96891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96209,9 +96901,9 @@ paths: application/json: schema: type: array - items: *560 + items: *563 examples: - default: *575 + default: *578 headers: Link: *37 x-github: @@ -96235,8 +96927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *118 - - *576 + - *121 + - *579 - *40 - *17 - *18 @@ -96248,11 +96940,11 @@ paths: schema: anyOf: - type: array - items: *577 + items: *580 - type: array - items: *54 + items: *57 examples: - default-response: *563 + default-response: *566 headers: Link: *37 x-github: @@ -96271,7 +96963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96281,9 +96973,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -96412,7 +97104,7 @@ webhooks: type: string enum: - disabled - enterprise: &578 + enterprise: &581 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -96481,7 +97173,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &579 + installation: &582 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -96502,7 +97194,7 @@ webhooks: required: - id - node_id - organization: &580 + organization: &583 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -96575,7 +97267,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &581 + repository: &584 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -96604,7 +97296,7 @@ webhooks: license: anyOf: - type: 'null' - - *70 + - *73 organization: anyOf: - type: 'null' @@ -97488,10 +98180,10 @@ webhooks: type: string enum: - enabled - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -97567,11 +98259,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: &582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: &585 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) @@ -97794,11 +98486,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: *582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: *585 sender: *4 required: - action @@ -97986,11 +98678,11 @@ webhooks: - everyone required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: *582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: *585 sender: *4 required: - action @@ -98074,7 +98766,7 @@ webhooks: type: string enum: - completed - check_run: &584 + check_run: &587 title: CheckRun description: A check performed on the code of a given code change type: object @@ -98142,8 +98834,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *306 - repository: *105 + items: *309 + repository: *108 status: type: string enum: @@ -98187,7 +98879,7 @@ webhooks: - examples: - neutral - deployment: *583 + deployment: *586 details_url: type: string examples: @@ -98247,7 +98939,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *306 + items: *309 started_at: type: string format: date-time @@ -98285,9 +98977,9 @@ webhooks: - output - app - pull_requests - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -98680,10 +99372,10 @@ webhooks: type: string enum: - created - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -99079,10 +99771,10 @@ webhooks: type: string enum: - requested_action - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 requested_action: description: The action requested by the user. type: object @@ -99487,10 +100179,10 @@ webhooks: type: string enum: - rerequested - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -100482,10 +101174,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -101170,10 +101862,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -101852,10 +102544,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -102162,20 +102854,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &585 + commit_oid: &588 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: *578 - installation: *579 - organization: *580 - ref: &586 + enterprise: *581 + installation: *582 + organization: *583 + ref: &589 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: *581 + repository: *584 sender: *4 required: - action @@ -102503,12 +103195,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -102606,7 +103298,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *321 + dismissed_comment: *324 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -102781,12 +103473,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103118,12 +103810,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103392,9 +104084,9 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -103402,7 +104094,7 @@ webhooks: type: - string - 'null' - repository: *581 + repository: *584 sender: *4 required: - action @@ -103634,12 +104326,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103901,10 +104593,10 @@ webhooks: - updated_at - author_association - body - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -103985,18 +104677,18 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *580 - pusher_type: &587 + organization: *583 + pusher_type: &590 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &588 + ref: &591 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -104006,7 +104698,7 @@ webhooks: enum: - tag - branch - repository: *581 + repository: *584 sender: *4 required: - ref @@ -104088,10 +104780,10 @@ webhooks: type: string enum: - created - definition: *188 - enterprise: *578 - installation: *579 - organization: *580 + definition: *191 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104175,9 +104867,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104253,10 +104945,10 @@ webhooks: type: string enum: - updated - definition: *188 - enterprise: *578 - installation: *579 - organization: *580 + definition: *191 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104332,19 +105024,19 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - repository: *581 - organization: *580 + enterprise: *581 + installation: *582 + repository: *584 + organization: *583 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *192 + items: *195 old_property_values: type: array description: The old custom property values for the repository. - items: *192 + items: *195 required: - action - repository @@ -104420,18 +105112,18 @@ webhooks: title: delete event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - pusher_type: *587 - ref: *588 + enterprise: *581 + installation: *582 + organization: *583 + pusher_type: *590 + ref: *591 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *581 + repository: *584 sender: *4 required: - ref @@ -104515,11 +105207,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104603,11 +105295,11 @@ webhooks: type: string enum: - auto_reopened - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104691,11 +105383,11 @@ webhooks: type: string enum: - created - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104777,11 +105469,11 @@ webhooks: type: string enum: - dismissed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104863,11 +105555,11 @@ webhooks: type: string enum: - fixed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104950,11 +105642,11 @@ webhooks: type: string enum: - reintroduced - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -105036,11 +105728,11 @@ webhooks: type: string enum: - reopened - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -105117,9 +105809,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - key: &589 + enterprise: *581 + installation: *582 + key: &592 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -105155,8 +105847,8 @@ webhooks: - verified - created_at - read_only - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -105233,11 +105925,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - key: *589 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + key: *592 + organization: *583 + repository: *584 sender: *4 required: - action @@ -105809,12 +106501,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: &593 + workflow: &596 title: Workflow type: - object @@ -106552,13 +107244,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *376 + deployment: *379 pull_requests: type: array - items: *457 - repository: *581 - organization: *580 - installation: *579 + items: *460 + repository: *584 + organization: *583 + installation: *582 sender: *4 responses: '200': @@ -106629,7 +107321,7 @@ webhooks: type: string enum: - approved - approver: &590 + approver: &593 type: object properties: avatar_url: @@ -106672,11 +107364,11 @@ webhooks: type: string comment: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - reviewers: &591 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + reviewers: &594 type: array items: type: object @@ -106757,7 +107449,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &592 + workflow_job_run: &595 type: object properties: conclusion: @@ -107503,18 +108195,18 @@ webhooks: type: string enum: - rejected - approver: *590 + approver: *593 comment: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - reviewers: *591 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + reviewers: *594 sender: *4 since: type: string - workflow_job_run: *592 + workflow_job_run: *595 workflow_job_runs: type: array items: @@ -108231,13 +108923,13 @@ webhooks: type: string enum: - requested - enterprise: *578 + enterprise: *581 environment: type: string - installation: *579 - organization: *580 - repository: *581 - requestor: &598 + installation: *582 + organization: *583 + repository: *584 + requestor: &601 title: User type: - object @@ -110180,12 +110872,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Deployment Workflow Run type: @@ -110876,7 +111568,7 @@ webhooks: type: string enum: - answered - answer: &596 + answer: &599 type: object properties: author_association: @@ -111036,7 +111728,7 @@ webhooks: - created_at - updated_at - body - discussion: &594 + discussion: &597 title: Discussion description: A Discussion in a repository. type: object @@ -111332,7 +112024,7 @@ webhooks: - id labels: type: array - items: *421 + items: *424 required: - repository_url - category @@ -111354,10 +112046,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111484,11 +112176,11 @@ webhooks: - from required: - category - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111571,11 +112263,11 @@ webhooks: type: string enum: - closed - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111657,7 +112349,7 @@ webhooks: type: string enum: - created - comment: &595 + comment: &598 type: object properties: author_association: @@ -111817,11 +112509,11 @@ webhooks: - updated_at - body - reactions - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111904,12 +112596,12 @@ webhooks: type: string enum: - deleted - comment: *595 - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + comment: *598 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112004,12 +112696,12 @@ webhooks: - from required: - body - comment: *595 - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + comment: *598 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112093,11 +112785,11 @@ webhooks: type: string enum: - created - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112179,11 +112871,11 @@ webhooks: type: string enum: - deleted - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112283,11 +112975,11 @@ webhooks: type: string required: - from - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112369,10 +113061,10 @@ webhooks: type: string enum: - labeled - discussion: *594 - enterprise: *578 - installation: *579 - label: &597 + discussion: *597 + enterprise: *581 + installation: *582 + label: &600 title: Label type: object properties: @@ -112405,8 +113097,8 @@ webhooks: - color - default - description - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112489,11 +113181,11 @@ webhooks: type: string enum: - locked - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112575,11 +113267,11 @@ webhooks: type: string enum: - pinned - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112661,11 +113353,11 @@ webhooks: type: string enum: - reopened - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112750,16 +113442,16 @@ webhooks: changes: type: object properties: - new_discussion: *594 - new_repository: *581 + new_discussion: *597 + new_repository: *584 required: - new_discussion - new_repository - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112842,10 +113534,10 @@ webhooks: type: string enum: - unanswered - discussion: *594 - old_answer: *596 - organization: *580 - repository: *581 + discussion: *597 + old_answer: *599 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112927,12 +113619,12 @@ webhooks: type: string enum: - unlabeled - discussion: *594 - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113015,11 +113707,11 @@ webhooks: type: string enum: - unlocked - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113101,11 +113793,11 @@ webhooks: type: string enum: - unpinned - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113178,7 +113870,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *578 + enterprise: *581 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -113856,9 +114548,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - forkee @@ -114004,9 +114696,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pages: description: The pages that were updated. type: array @@ -114044,7 +114736,7 @@ webhooks: - action - sha - html_url - repository: *581 + repository: *584 sender: *4 required: - pages @@ -114120,10 +114812,10 @@ webhooks: type: string enum: - created - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: &599 + organization: *583 + repositories: &602 description: An array of repository objects that the installation can access. type: array @@ -114149,8 +114841,8 @@ webhooks: - name - full_name - private - repository: *581 - requester: *598 + repository: *584 + requester: *601 sender: *4 required: - action @@ -114225,11 +114917,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114306,11 +114998,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114387,10 +115079,10 @@ webhooks: type: string enum: - added - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories_added: &600 + organization: *583 + repositories_added: &603 description: An array of repository objects, which were added to the installation. type: array @@ -114436,15 +115128,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *581 - repository_selection: &601 + repository: *584 + repository_selection: &604 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *598 + requester: *601 sender: *4 required: - action @@ -114523,10 +115215,10 @@ webhooks: type: string enum: - removed - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories_added: *600 + organization: *583 + repositories_added: *603 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -114553,9 +115245,9 @@ webhooks: - name - full_name - private - repository: *581 - repository_selection: *601 - requester: *598 + repository: *584 + repository_selection: *604 + requester: *601 sender: *4 required: - action @@ -114634,11 +115326,11 @@ webhooks: type: string enum: - suspend - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114820,10 +115512,10 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 target_type: type: string @@ -114902,11 +115594,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -115154,8 +115846,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -116331,8 +117023,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -116412,7 +117104,7 @@ webhooks: type: string enum: - deleted - comment: &602 + comment: &605 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -116579,8 +117271,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -117754,8 +118446,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -117835,7 +118527,7 @@ webhooks: type: string enum: - edited - changes: &627 + changes: &630 description: The changes to the comment. type: object properties: @@ -117847,9 +118539,9 @@ webhooks: type: string required: - from - comment: *602 - enterprise: *578 - installation: *579 + comment: *605 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119024,8 +119716,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -119107,10 +119799,10 @@ webhooks: type: string enum: - assigned - assignee: *598 - enterprise: *578 - installation: *579 - issue: &605 + assignee: *601 + enterprise: *581 + installation: *582 + issue: &608 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -120040,8 +120732,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -120121,8 +120813,8 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -121200,8 +121892,8 @@ webhooks: required: - state - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -121280,8 +121972,8 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122204,8 +122896,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -122284,8 +122976,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123212,7 +123904,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &603 + milestone: &606 title: Milestone description: A collection of related issues and pull requests. type: object @@ -123355,8 +124047,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -123455,8 +124147,8 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124386,9 +125078,9 @@ webhooks: - active_lock_reason - body - reactions - label: *597 - organization: *580 - repository: *581 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -124468,8 +125160,8 @@ webhooks: type: string enum: - labeled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125398,9 +126090,9 @@ webhooks: - active_lock_reason - body - reactions - label: *597 - organization: *580 - repository: *581 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -125480,8 +126172,8 @@ webhooks: type: string enum: - locked - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126412,8 +127104,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -126492,8 +127184,8 @@ webhooks: type: string enum: - milestoned - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127418,9 +128110,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *603 - organization: *580 - repository: *581 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -128906,8 +129598,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129836,8 +130528,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -129917,9 +130609,9 @@ webhooks: type: string enum: - pinned - enterprise: *578 - installation: *579 - issue: &604 + enterprise: *581 + installation: *582 + issue: &607 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130842,8 +131534,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -130922,8 +131614,8 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131853,8 +132545,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133340,11 +134032,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *578 - installation: *579 - issue: *604 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *607 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133425,7 +134117,7 @@ webhooks: type: string enum: - unassigned - assignee: &630 + assignee: &633 title: User type: - object @@ -133497,11 +134189,11 @@ webhooks: required: - login - id - enterprise: *578 - installation: *579 - issue: *605 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *608 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133580,12 +134272,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *578 - installation: *579 - issue: *605 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *608 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133665,8 +134357,8 @@ webhooks: type: string enum: - unlocked - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134595,8 +135287,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134676,11 +135368,11 @@ webhooks: type: string enum: - unpinned - enterprise: *578 - installation: *579 - issue: *604 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *607 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134759,11 +135451,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134841,11 +135533,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134955,11 +135647,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -135041,9 +135733,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: &606 + enterprise: *581 + installation: *582 + marketplace_purchase: &609 title: Marketplace Purchase type: object required: @@ -135131,8 +135823,8 @@ webhooks: type: integer unit_count: type: integer - organization: *580 - previous_marketplace_purchase: &607 + organization: *583 + previous_marketplace_purchase: &610 title: Marketplace Purchase type: object properties: @@ -135216,7 +135908,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135296,10 +135988,10 @@ webhooks: - changed effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -135387,7 +136079,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135469,10 +136161,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -135558,7 +136250,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135639,8 +136331,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 marketplace_purchase: title: Marketplace Purchase type: object @@ -135726,9 +136418,9 @@ webhooks: type: integer unit_count: type: integer - organization: *580 - previous_marketplace_purchase: *607 - repository: *581 + organization: *583 + previous_marketplace_purchase: *610 + repository: *584 sender: *4 required: - action @@ -135808,12 +136500,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 - previous_marketplace_purchase: *607 - repository: *581 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 + previous_marketplace_purchase: *610 + repository: *584 sender: *4 required: - action @@ -135915,11 +136607,11 @@ webhooks: type: string required: - to - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136021,11 +136713,11 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136104,11 +136796,11 @@ webhooks: type: string enum: - removed - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136186,11 +136878,11 @@ webhooks: type: string enum: - added - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 scope: description: The scope of the membership. Currently, can only be `team`. @@ -136268,7 +136960,7 @@ webhooks: required: - login - id - team: &608 + team: &611 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -136461,11 +137153,11 @@ webhooks: type: string enum: - removed - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 scope: description: The scope of the membership. Currently, can only be `team`. @@ -136544,7 +137236,7 @@ webhooks: required: - login - id - team: *608 + team: *611 required: - action - scope @@ -136626,8 +137318,8 @@ webhooks: type: string enum: - checks_requested - installation: *579 - merge_group: &609 + installation: *582 + merge_group: &612 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -136646,15 +137338,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *310 + head_commit: *313 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136740,10 +137432,10 @@ webhooks: - merged - invalidated - dequeued - installation: *579 - merge_group: *609 - organization: *580 - repository: *581 + installation: *582 + merge_group: *612 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136816,7 +137508,7 @@ webhooks: type: string enum: - deleted - enterprise: *578 + enterprise: *581 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -136924,12 +137616,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *579 - organization: *580 + installation: *582 + organization: *583 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -137009,11 +137701,11 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137092,9 +137784,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - milestone: &610 + enterprise: *581 + installation: *582 + milestone: &613 title: Milestone description: A collection of related issues and pull requests. type: object @@ -137236,8 +137928,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137316,11 +138008,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137430,11 +138122,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137514,11 +138206,11 @@ webhooks: type: string enum: - opened - enterprise: *578 - installation: *579 - milestone: *610 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *613 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137597,11 +138289,11 @@ webhooks: type: string enum: - blocked - blocked_user: *598 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + blocked_user: *601 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137680,11 +138372,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *598 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + blocked_user: *601 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137763,9 +138455,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - membership: &611 + enterprise: *581 + installation: *582 + membership: &614 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -137859,8 +138551,8 @@ webhooks: - role - organization_url - user - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137938,11 +138630,11 @@ webhooks: type: string enum: - member_added - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138021,8 +138713,8 @@ webhooks: type: string enum: - member_invited - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -138144,10 +138836,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 - user: *598 + user: *601 required: - action - invitation @@ -138225,11 +138917,11 @@ webhooks: type: string enum: - member_removed - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138316,11 +139008,11 @@ webhooks: properties: from: type: string - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138396,9 +139088,9 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 package: description: Information about the package. type: object @@ -138921,7 +139613,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &612 + items: &615 title: Ruby Gems metadata type: object properties: @@ -139018,7 +139710,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -139094,9 +139786,9 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 package: description: Information about the package. type: object @@ -139458,7 +140150,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *612 + items: *615 source_url: type: string format: uri @@ -139529,7 +140221,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -139710,12 +140402,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *578 + enterprise: *581 id: type: integer - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - id @@ -139795,7 +140487,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &613 + personal_access_token_request: &616 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -139933,10 +140625,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *578 - organization: *580 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140015,11 +140707,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *613 - enterprise: *578 - organization: *580 + personal_access_token_request: *616 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140097,11 +140789,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *613 - enterprise: *578 - organization: *580 + personal_access_token_request: *616 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140178,11 +140870,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *613 - organization: *580 - enterprise: *578 + personal_access_token_request: *616 + organization: *583 + enterprise: *581 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140286,7 +140978,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *614 + last_response: *617 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -140318,8 +141010,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 zen: description: Random string of GitHub zen. @@ -140564,10 +141256,10 @@ webhooks: - from required: - note - enterprise: *578 - installation: *579 - organization: *580 - project_card: &615 + enterprise: *581 + installation: *582 + organization: *583 + project_card: &618 title: Project Card type: object properties: @@ -140690,7 +141382,7 @@ webhooks: - creator - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -140771,11 +141463,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project_card: *615 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_card: *618 + repository: *584 sender: *4 required: - action @@ -140855,9 +141547,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 project_card: title: Project Card type: object @@ -140987,7 +141679,7 @@ webhooks: repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -141081,11 +141773,11 @@ webhooks: - from required: - note - enterprise: *578 - installation: *579 - organization: *580 - project_card: *615 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_card: *618 + repository: *584 sender: *4 required: - action @@ -141179,9 +141871,9 @@ webhooks: - from required: - column_id - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 project_card: allOf: - title: Project Card @@ -141378,7 +142070,7 @@ webhooks: type: string required: - after_id - repository: *581 + repository: *584 sender: *4 required: - action @@ -141458,10 +142150,10 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - organization: *580 - project: &617 + enterprise: *581 + installation: *582 + organization: *583 + project: &620 title: Project type: object properties: @@ -141588,7 +142280,7 @@ webhooks: - creator - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -141668,10 +142360,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project_column: &616 + enterprise: *581 + installation: *582 + organization: *583 + project_column: &619 title: Project Column type: object properties: @@ -141711,7 +142403,7 @@ webhooks: - name - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -141790,14 +142482,14 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -141886,11 +142578,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 + repository: *584 sender: *4 required: - action @@ -141970,11 +142662,11 @@ webhooks: type: string enum: - moved - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 + repository: *584 sender: *4 required: - action @@ -142054,11 +142746,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142138,14 +142830,14 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - project: *617 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -142246,11 +142938,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142329,11 +143021,11 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142414,9 +143106,9 @@ webhooks: type: string enum: - closed - installation: *579 - organization: *580 - projects_v2: &618 + installation: *582 + organization: *583 + projects_v2: &621 title: Projects v2 Project description: A projects v2 project type: object @@ -142564,9 +143256,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142647,9 +143339,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142770,9 +143462,9 @@ webhooks: type: string to: type: string - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142855,7 +143547,7 @@ webhooks: type: string enum: - archived - changes: &622 + changes: &625 type: object properties: archived_at: @@ -142871,9 +143563,9 @@ webhooks: - string - 'null' format: date-time - installation: *579 - organization: *580 - projects_v2_item: &619 + installation: *582 + organization: *583 + projects_v2_item: &622 title: Projects v2 Item description: An item belonging to a project type: object @@ -143012,9 +143704,9 @@ webhooks: - 'null' to: type: string - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143096,9 +143788,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143179,9 +143871,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143286,7 +143978,7 @@ webhooks: oneOf: - type: string - type: integer - - &620 + - &623 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -143306,7 +143998,7 @@ webhooks: required: - id - name - - &621 + - &624 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -143335,8 +144027,8 @@ webhooks: oneOf: - type: string - type: integer - - *620 - - *621 + - *623 + - *624 type: - 'null' - string @@ -143359,9 +144051,9 @@ webhooks: - 'null' required: - body - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143458,9 +144150,9 @@ webhooks: type: - string - 'null' - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143543,10 +144235,10 @@ webhooks: type: string enum: - restored - changes: *622 - installation: *579 - organization: *580 - projects_v2_item: *619 + changes: *625 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143628,9 +144320,9 @@ webhooks: type: string enum: - reopened - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -143711,9 +144403,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2_status_update: &623 + installation: *582 + organization: *583 + projects_v2_status_update: &626 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -143848,9 +144540,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2_status_update: *623 + installation: *582 + organization: *583 + projects_v2_status_update: *626 sender: *4 required: - action @@ -143996,9 +144688,9 @@ webhooks: - string - 'null' format: date - installation: *579 - organization: *580 - projects_v2_status_update: *623 + installation: *582 + organization: *583 + projects_v2_status_update: *626 sender: *4 required: - action @@ -144069,10 +144761,10 @@ webhooks: title: public event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - repository @@ -144149,13 +144841,13 @@ webhooks: type: string enum: - assigned - assignee: *598 - enterprise: *578 - installation: *579 - number: &624 + assignee: *601 + enterprise: *581 + installation: *582 + number: &627 description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -146504,7 +147196,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -146586,11 +147278,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -148932,7 +149624,7 @@ webhooks: - draft reason: type: string - repository: *581 + repository: *584 sender: *4 required: - action @@ -149014,11 +149706,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -151360,7 +152052,7 @@ webhooks: - draft reason: type: string - repository: *581 + repository: *584 sender: *4 required: - action @@ -151442,13 +152134,13 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: &625 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: &628 allOf: - - *457 + - *460 - type: object properties: allow_auto_merge: @@ -151510,7 +152202,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *581 + repository: *584 sender: *4 required: - action @@ -151591,12 +152283,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -151676,11 +152368,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *578 - milestone: *356 - number: *624 - organization: *580 - pull_request: &626 + enterprise: *581 + milestone: *359 + number: *627 + organization: *583 + pull_request: &629 title: Pull Request type: object properties: @@ -154007,7 +154699,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -154086,11 +154778,11 @@ webhooks: type: string enum: - dequeued - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -156436,7 +157128,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *581 + repository: *584 sender: *4 required: - action @@ -156560,12 +157252,12 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -156645,11 +157337,11 @@ webhooks: type: string enum: - enqueued - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -158980,7 +159672,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -159060,11 +159752,11 @@ webhooks: type: string enum: - labeled - enterprise: *578 - installation: *579 - label: *597 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + label: *600 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -161412,7 +162104,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -161493,10 +162185,10 @@ webhooks: type: string enum: - locked - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -163842,7 +164534,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -163922,12 +164614,12 @@ webhooks: type: string enum: - milestoned - enterprise: *578 - milestone: *356 - number: *624 - organization: *580 - pull_request: *626 - repository: *581 + enterprise: *581 + milestone: *359 + number: *627 + organization: *583 + pull_request: *629 + repository: *584 sender: *4 required: - action @@ -164006,12 +164698,12 @@ webhooks: type: string enum: - opened - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164092,12 +164784,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164177,12 +164869,12 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164557,9 +165249,9 @@ webhooks: - start_side - side - reactions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -166789,7 +167481,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -166869,7 +167561,7 @@ webhooks: type: string enum: - deleted - comment: &628 + comment: &631 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -167162,9 +167854,9 @@ webhooks: - start_side - side - reactions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -169382,7 +170074,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -169462,11 +170154,11 @@ webhooks: type: string enum: - edited - changes: *627 - comment: *628 - enterprise: *578 - installation: *579 - organization: *580 + changes: *630 + comment: *631 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -171687,7 +172379,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -171768,9 +172460,9 @@ webhooks: type: string enum: - dismissed - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -174003,7 +174695,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 review: description: The review that was affected. type: object @@ -174249,9 +174941,9 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -176365,8 +177057,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 - review: &629 + repository: *584 + review: &632 description: The review that was affected. type: object properties: @@ -176599,12 +177291,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -178951,7 +179643,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_reviewer: title: User type: @@ -179037,12 +179729,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -181396,7 +182088,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_team: title: Team description: Groups of organization members that gives permissions @@ -181591,12 +182283,12 @@ webhooks: type: string enum: - review_requested - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -183945,7 +184637,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_reviewer: title: User type: @@ -184032,12 +184724,12 @@ webhooks: type: string enum: - review_requested - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -186377,7 +187069,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_team: title: Team description: Groups of organization members that gives permissions @@ -186561,9 +187253,9 @@ webhooks: type: string enum: - submitted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -188799,8 +189491,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 - review: *629 + repository: *584 + review: *632 sender: *4 required: - action @@ -188880,9 +189572,9 @@ webhooks: type: string enum: - resolved - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -191013,7 +191705,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 sender: *4 thread: type: object @@ -191405,9 +192097,9 @@ webhooks: type: string enum: - unresolved - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -193521,7 +194213,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 sender: *4 thread: type: object @@ -193915,10 +194607,10 @@ webhooks: type: string before: type: string - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -196253,7 +196945,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -196335,11 +197027,11 @@ webhooks: type: string enum: - unassigned - assignee: *630 - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + assignee: *633 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -198689,7 +199381,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -198768,11 +199460,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *578 - installation: *579 - label: *597 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + label: *600 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -201111,7 +201803,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -201192,10 +201884,10 @@ webhooks: type: string enum: - unlocked - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -203524,7 +204216,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -203727,7 +204419,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *578 + enterprise: *581 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -203822,8 +204514,8 @@ webhooks: - url - author - committer - installation: *579 - organization: *580 + installation: *582 + organization: *583 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -204411,9 +205103,9 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 registry_package: type: object properties: @@ -204890,7 +205582,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *612 + items: *615 summary: type: string tag_name: @@ -204946,7 +205638,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -205024,9 +205716,9 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 registry_package: type: object properties: @@ -205338,7 +206030,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *612 + items: *615 summary: type: string tag_name: @@ -205388,7 +206080,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -205465,10 +206157,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - release: &631 + enterprise: *581 + installation: *582 + organization: *583 + release: &634 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -205784,7 +206476,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *581 + repository: *584 sender: *4 required: - action @@ -205861,11 +206553,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -205973,11 +206665,11 @@ webhooks: type: boolean required: - to - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -206055,9 +206747,9 @@ webhooks: type: string enum: - prereleased - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -206378,7 +207070,7 @@ webhooks: - string - 'null' format: uri - repository: *581 + repository: *584 sender: *4 required: - action @@ -206454,10 +207146,10 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - release: &632 + enterprise: *581 + installation: *582 + organization: *583 + release: &635 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -206775,7 +207467,7 @@ webhooks: - string - 'null' format: uri - repository: *581 + repository: *584 sender: *4 required: - action @@ -206851,11 +207543,11 @@ webhooks: type: string enum: - released - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -206931,11 +207623,11 @@ webhooks: type: string enum: - unpublished - enterprise: *578 - installation: *579 - organization: *580 - release: *632 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *635 + repository: *584 sender: *4 required: - action @@ -207011,11 +207703,11 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_advisory: *510 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_advisory: *513 sender: *4 required: - action @@ -207091,11 +207783,11 @@ webhooks: type: string enum: - reported - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_advisory: *510 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_advisory: *513 sender: *4 required: - action @@ -207171,10 +207863,10 @@ webhooks: type: string enum: - archived - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207251,10 +207943,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207332,10 +208024,10 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207420,10 +208112,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207538,10 +208230,10 @@ webhooks: - 'null' items: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207613,10 +208305,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 status: type: string @@ -207697,10 +208389,10 @@ webhooks: type: string enum: - privatized - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207777,10 +208469,10 @@ webhooks: type: string enum: - publicized - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207874,10 +208566,10 @@ webhooks: - name required: - repository - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207957,11 +208649,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 sender: *4 required: - action @@ -208039,11 +208731,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 sender: *4 required: - action @@ -208121,11 +208813,11 @@ webhooks: type: string enum: - edited - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 changes: type: object properties: @@ -208144,16 +208836,16 @@ webhooks: properties: added: type: array - items: *194 + items: *197 deleted: type: array - items: *194 + items: *197 updated: type: array items: type: object properties: - condition: *194 + condition: *197 changes: type: object properties: @@ -208186,16 +208878,16 @@ webhooks: properties: added: type: array - items: *199 + items: *202 deleted: type: array - items: *199 + items: *202 updated: type: array items: type: object properties: - rule: *199 + rule: *202 changes: type: object properties: @@ -208432,10 +209124,10 @@ webhooks: - from required: - owner - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208513,10 +209205,10 @@ webhooks: type: string enum: - unarchived - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208594,7 +209286,7 @@ webhooks: type: string enum: - create - alert: &633 + alert: &636 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -208718,10 +209410,10 @@ webhooks: type: string enum: - open - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208931,10 +209623,10 @@ webhooks: type: string enum: - dismissed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209012,11 +209704,11 @@ webhooks: type: string enum: - reopen - alert: *633 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209218,10 +209910,10 @@ webhooks: enum: - fixed - open - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209299,7 +209991,7 @@ webhooks: type: string enum: - created - alert: &634 + alert: &637 type: object properties: number: *46 @@ -209387,10 +210079,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209471,11 +210163,11 @@ webhooks: type: string enum: - created - alert: *634 - installation: *579 - location: *635 - organization: *580 - repository: *581 + alert: *637 + installation: *582 + location: *638 + organization: *583 + repository: *584 sender: *4 required: - location @@ -209713,11 +210405,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209795,11 +210487,11 @@ webhooks: type: string enum: - reopened - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209877,11 +210569,11 @@ webhooks: type: string enum: - resolved - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209959,11 +210651,11 @@ webhooks: type: string enum: - validated - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -210039,11 +210731,11 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - security_advisory: &636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + security_advisory: &639 description: The details of the security advisory, including summary, description, and severity. type: object @@ -210229,11 +210921,11 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - security_advisory: *636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + security_advisory: *639 sender: *4 required: - action @@ -210306,10 +210998,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -210495,11 +211187,11 @@ webhooks: from: type: object properties: - security_and_analysis: *193 - enterprise: *578 - installation: *579 - organization: *580 - repository: *238 + security_and_analysis: *196 + enterprise: *581 + installation: *582 + organization: *583 + repository: *241 sender: *4 required: - changes @@ -210577,12 +211269,12 @@ webhooks: type: string enum: - cancelled - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: &637 + sponsorship: &640 type: object properties: created_at: @@ -210887,12 +211579,12 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - sponsorship @@ -210980,12 +211672,12 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211062,17 +211754,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &638 + effective_date: &641 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: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - sponsorship @@ -211146,7 +211838,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &639 + changes: &642 type: object properties: tier: @@ -211190,13 +211882,13 @@ webhooks: - from required: - tier - effective_date: *638 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + effective_date: *641 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211273,13 +211965,13 @@ webhooks: type: string enum: - tier_changed - changes: *639 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + changes: *642 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211353,10 +212045,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -211440,10 +212132,10 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -211872,15 +212564,15 @@ webhooks: type: - string - 'null' - enterprise: *578 + enterprise: *581 id: description: The unique identifier of the status. type: integer - installation: *579 + installation: *582 name: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 sha: description: The Commit SHA. @@ -211990,15 +212682,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - parent_issue_repo: *54 + parent_issue: *72 + parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - installation: *579 - organization: *580 - repository: *581 + sub_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212082,15 +212774,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - parent_issue_repo: *54 + parent_issue: *72 + parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - installation: *579 - organization: *580 - repository: *581 + sub_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212174,15 +212866,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - sub_issue_repo: *54 + sub_issue: *72 + sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - installation: *579 - organization: *580 - repository: *581 + parent_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212266,15 +212958,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - sub_issue_repo: *54 + sub_issue: *72 + sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - installation: *579 - organization: *580 - repository: *581 + parent_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212351,12 +213043,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - team: &640 + team: &643 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -212549,9 +213241,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -213021,7 +213713,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -213097,9 +213789,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -213569,7 +214261,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -213646,9 +214338,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -214118,7 +214810,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -214262,9 +214954,9 @@ webhooks: - from required: - permissions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -214734,7 +215426,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - changes @@ -214812,9 +215504,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -215284,7 +215976,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -215360,10 +216052,10 @@ webhooks: type: string enum: - started - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -215436,17 +216128,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *578 + enterprise: *581 inputs: type: - object - 'null' additionalProperties: true - installation: *579 - organization: *580 + installation: *582 + organization: *583 ref: type: string - repository: *581 + repository: *584 sender: *4 workflow: type: string @@ -215528,10 +216220,10 @@ webhooks: type: string enum: - completed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: allOf: @@ -215787,7 +216479,7 @@ webhooks: type: string required: - conclusion - deployment: *376 + deployment: *379 required: - action - repository @@ -215866,10 +216558,10 @@ webhooks: type: string enum: - in_progress - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: allOf: @@ -216151,7 +216843,7 @@ webhooks: required: - status - steps - deployment: *376 + deployment: *379 required: - action - repository @@ -216230,10 +216922,10 @@ webhooks: type: string enum: - queued - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: type: object @@ -216379,7 +217071,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *376 + deployment: *379 required: - action - repository @@ -216458,10 +217150,10 @@ webhooks: type: string enum: - waiting - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: type: object @@ -216608,7 +217300,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *376 + deployment: *379 required: - action - repository @@ -216688,12 +217380,12 @@ webhooks: type: string enum: - completed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object @@ -217712,12 +218404,12 @@ webhooks: type: string enum: - in_progress - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object @@ -218721,12 +219413,12 @@ webhooks: type: string enum: - requested - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index a954fb3ee9..50acd0c1f4 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -18689,6 +18689,662 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -22444,6 +23100,671 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -80321,6 +81642,662 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -144110,6 +146087,671 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 70df391d9c..a6a9b7265f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -888,7 +888,7 @@ paths: - subscriptions_url - type - url - type: &211 + type: &214 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1021,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &90 + schema: &93 title: Validation Error Simple description: Validation Error Simple type: object @@ -1054,7 +1054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &512 + - &515 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1585,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &147 + - &150 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 @@ -1606,7 +1606,7 @@ paths: application/json: schema: type: array - items: &148 + items: &151 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1699,7 +1699,7 @@ paths: - installation_id - repository_id examples: - default: &149 + default: &152 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1762,7 +1762,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &89 + schema: &92 title: Validation Error description: Validation Error type: object @@ -1834,7 +1834,7 @@ paths: description: Response content: application/json: - schema: &150 + schema: &153 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1969,7 +1969,7 @@ paths: - request - response examples: - default: &151 + default: &154 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2029,7 +2029,7 @@ paths: parameters: - *16 responses: - '202': &91 + '202': &94 description: Accepted content: application/json: @@ -2238,7 +2238,7 @@ paths: parameters: - *17 - *18 - - &59 + - &62 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) @@ -2975,7 +2975,7 @@ paths: - selected repositories: type: array - items: &54 + items: &57 title: Repository description: A repository on GitHub. type: object @@ -3002,7 +3002,7 @@ paths: license: anyOf: - type: 'null' - - &70 + - &73 title: License Simple description: License Simple type: object @@ -7280,7 +7280,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &130 + items: &133 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -7290,7 +7290,7 @@ paths: organization: anyOf: - type: 'null' - - &85 + - &88 title: Organization Simple description: A GitHub organization. type: object @@ -7365,7 +7365,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &158 + - &161 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -7424,7 +7424,7 @@ paths: parent: anyOf: - type: 'null' - - &172 + - &175 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -7618,7 +7618,7 @@ paths: - created_at additionalProperties: false examples: - default: &131 + default: &134 value: total_seats: 2 seats: @@ -7700,6 +7700,487 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - *38 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &52 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true + examples: + default: &53 + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + '500': *39 + '403': *27 + '404': *6 + '422': &54 + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: *3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -7757,7 +8238,7 @@ paths: application/json: schema: type: array - items: &52 + items: &55 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7937,7 +8418,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &133 + - &136 name: state in: query description: |- @@ -7946,7 +8427,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &134 + - &137 name: severity in: query description: |- @@ -7955,7 +8436,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &135 + - &138 name: ecosystem in: query description: |- @@ -7964,14 +8445,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &136 + - &139 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 - - &137 + - &140 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7981,7 +8462,7 @@ paths: enum: - development - runtime - - &138 + - &141 name: sort in: query description: |- @@ -7997,7 +8478,7 @@ paths: - *40 - *41 - *42 - - &139 + - &142 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8010,7 +8491,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &140 + - &143 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8030,7 +8511,7 @@ paths: application/json: schema: type: array - items: &141 + items: &144 type: object description: A Dependabot alert. properties: @@ -8085,7 +8566,7 @@ paths: - development - runtime - - security_advisory: &368 + security_advisory: &371 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8313,7 +8794,7 @@ paths: 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &120 + dismissed_at: &123 type: - string - 'null' @@ -8344,7 +8825,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &119 + fixed_at: &122 type: - string - 'null' @@ -8352,7 +8833,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &369 + auto_dismissed_at: &372 type: - string - 'null' @@ -8700,7 +9181,7 @@ paths: - repository additionalProperties: false examples: - default: &142 + default: &145 value: - number: 2 state: dismissed @@ -9044,7 +9525,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &202 + - &205 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9055,7 +9536,7 @@ paths: enum: - open - resolved - - &203 + - &206 name: secret_type in: query description: |- @@ -9065,7 +9546,7 @@ paths: required: false schema: type: string - - &204 + - &207 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9074,7 +9555,7 @@ paths: required: false schema: type: string - - &205 + - &208 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. @@ -9090,7 +9571,7 @@ paths: - *17 - *41 - *42 - - &206 + - &209 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9099,7 +9580,7 @@ paths: required: false schema: type: string - - &207 + - &210 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9108,7 +9589,7 @@ paths: schema: type: boolean default: false - - &208 + - &211 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9124,7 +9605,7 @@ paths: application/json: schema: type: array - items: &209 + items: &212 type: object properties: number: *46 @@ -9140,14 +9621,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &505 + state: &508 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: &506 + resolution: &509 type: - string - 'null' @@ -9224,7 +9705,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &210 + default: &213 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9433,7 +9914,7 @@ paths: headers: Link: *37 '404': *6 - '503': &57 + '503': &60 description: Service unavailable content: application/json: @@ -9451,6 +9932,80 @@ paths: enabledForGitHubApps: false category: secret-scanning subcategory: secret-scanning + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - *38 + - name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -9480,7 +10035,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &169 + - &172 name: team_slug description: The slug of the team name. in: path @@ -9518,9 +10073,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: &132 + default: &135 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -9615,7 +10170,7 @@ paths: application/json: schema: type: array - items: &80 + items: &83 title: Event description: Event type: object @@ -9626,7 +10181,7 @@ paths: type: - string - 'null' - actor: &53 + actor: &56 title: Actor description: Actor type: object @@ -9667,13 +10222,13 @@ paths: - id - name - url - org: *53 + org: *56 payload: type: object properties: action: type: string - issue: &69 + issue: &72 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -9793,7 +10348,7 @@ paths: milestone: anyOf: - type: 'null' - - &356 + - &359 title: Milestone description: A collection of related issues and pull requests. @@ -9965,12 +10520,12 @@ paths: timeline_url: type: string format: uri - repository: *54 + repository: *57 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &55 + author_association: &58 title: author_association type: string description: How the author is associated with the repository. @@ -9985,7 +10540,7 @@ paths: - OWNER examples: - OWNER - reactions: &56 + reactions: &59 title: Reaction Rollup type: object properties: @@ -10043,7 +10598,7 @@ paths: - author_association - created_at - updated_at - comment: &415 + comment: &418 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10093,12 +10648,12 @@ paths: issue_url: type: string format: uri - author_association: *55 + author_association: *58 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - id - node_id @@ -10195,7 +10750,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10285,7 +10840,7 @@ paths: _links: type: object properties: - timeline: &58 + timeline: &61 title: Link With Type description: Hypermedia Link with Type type: object @@ -10297,17 +10852,17 @@ paths: required: - href - type - user: *58 - security_advisories: *58 - current_user: *58 - current_user_public: *58 - current_user_actor: *58 - current_user_organization: *58 + user: *61 + security_advisories: *61 + current_user: *61 + current_user_public: *61 + current_user_actor: *61 + current_user_organization: *61 current_user_organizations: type: array - items: *58 - repository_discussions: *58 - repository_discussions_category: *58 + items: *61 + repository_discussions: *61 + repository_discussions_category: *61 required: - timeline - user @@ -10369,7 +10924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *59 + - *62 - *17 - *18 responses: @@ -10379,7 +10934,7 @@ paths: application/json: schema: type: array - items: &60 + items: &63 title: Base Gist description: Base Gist type: object @@ -10469,7 +11024,7 @@ paths: - created_at - updated_at examples: - default: &61 + default: &64 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10593,7 +11148,7 @@ paths: description: Response content: application/json: - schema: &62 + schema: &65 title: Gist Simple description: Gist Simple type: object @@ -10611,7 +11166,7 @@ paths: url: type: string format: uri - user: &535 + user: &538 title: Public User description: Public User type: object @@ -10976,7 +11531,7 @@ paths: truncated: type: boolean examples: - default: &63 + default: &66 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11078,7 +11633,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *59 + - *62 - *17 - *18 responses: @@ -11088,9 +11643,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '422': *15 @@ -11112,7 +11667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *59 + - *62 - *17 - *18 responses: @@ -11122,9 +11677,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '401': *23 @@ -11152,7 +11707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &64 + - &67 name: gist_id description: The unique identifier of the gist. in: path @@ -11164,10 +11719,10 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - default: *63 - '403': &67 + default: *66 + '403': &70 description: Forbidden Gist content: application/json: @@ -11216,7 +11771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *64 + - *67 requestBody: required: true content: @@ -11280,9 +11835,9 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - updateGist: *63 + updateGist: *66 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -11440,7 +11995,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -11469,7 +12024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11479,7 +12034,7 @@ paths: application/json: schema: type: array - items: &65 + items: &68 title: Gist Comment description: A comment made to a gist. type: object @@ -11517,7 +12072,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *55 + author_association: *58 required: - url - id @@ -11582,7 +12137,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *64 + - *67 requestBody: required: true content: @@ -11608,9 +12163,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: &66 + default: &69 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11668,8 +12223,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *64 - - &68 + - *67 + - &71 name: comment_id description: The unique identifier of the comment. in: path @@ -11682,12 +12237,12 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '304': *35 '404': *6 - '403': *67 + '403': *70 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11709,8 +12264,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *64 - - *68 + - *67 + - *71 requestBody: required: true content: @@ -11736,9 +12291,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '404': *6 x-github: githubCloudOnly: false @@ -11755,8 +12310,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *64 - - *68 + - *67 + - *71 responses: '204': description: Response @@ -11779,7 +12334,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11880,7 +12435,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *64 + - *67 - *17 - *18 responses: @@ -11890,7 +12445,7 @@ paths: application/json: schema: type: array - items: *62 + items: *65 examples: default: value: @@ -11955,13 +12510,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *64 + - *67 responses: '201': description: Response content: application/json: - schema: *60 + schema: *63 examples: default: value: @@ -12032,7 +12587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *64 + - *67 responses: '204': description: Response if gist is starred @@ -12062,7 +12617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -12084,7 +12639,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *64 + - *67 responses: '204': description: Response @@ -12113,7 +12668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *64 + - *67 - name: sha in: path required: true @@ -12124,9 +12679,9 @@ paths: description: Response content: application/json: - schema: *62 + schema: *65 examples: - default: *63 + default: *66 '422': *15 '404': *6 '403': *27 @@ -12287,7 +12842,7 @@ paths: type: integer repositories: type: array - items: *54 + items: *57 repository_selection: type: string examples: @@ -12495,7 +13050,7 @@ paths: - closed - all default: open - - &159 + - &162 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12514,7 +13069,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - name: collab in: query required: false @@ -12544,9 +13099,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: &160 + default: &163 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12826,7 +13381,7 @@ paths: application/json: schema: type: array - items: *70 + items: *73 examples: default: value: @@ -13123,7 +13678,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &71 + X-CommonMarker-Version: &74 example: 0.17.4 schema: type: string @@ -13178,7 +13733,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *71 + X-CommonMarker-Version: *74 content: text/html: schema: @@ -13207,7 +13762,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &74 + - &77 name: account_id description: account_id parameter in: path @@ -13219,7 +13774,7 @@ paths: description: Response content: application/json: - schema: &73 + schema: &76 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13253,7 +13808,7 @@ paths: - 'null' id: type: integer - plan: &72 + plan: &75 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13356,7 +13911,7 @@ paths: - 'null' updated_at: type: string - plan: *72 + plan: *75 required: - url - id @@ -13364,7 +13919,7 @@ paths: - login - marketplace_purchase examples: - default: &75 + default: &78 value: url: https://api.github.com/orgs/github type: Organization @@ -13449,9 +14004,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: &76 + default: &79 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -13491,14 +14046,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &77 + - &80 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &78 + - &81 name: sort description: The property to sort the results by. in: query @@ -13528,9 +14083,9 @@ paths: application/json: schema: type: array - items: *73 + items: *76 examples: - default: &79 + default: &82 value: - url: https://api.github.com/orgs/github type: Organization @@ -13604,15 +14159,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *74 + - *77 responses: '200': description: Response content: application/json: - schema: *73 + schema: *76 examples: - default: *75 + default: *78 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -13644,9 +14199,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *76 + default: *79 headers: Link: *37 '401': *23 @@ -13669,8 +14224,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *77 - - *78 + - *80 + - *81 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13690,9 +14245,9 @@ paths: application/json: schema: type: array - items: *73 + items: *76 examples: - default: *79 + default: *82 headers: Link: *37 '401': *23 @@ -13942,14 +14497,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &227 + - &230 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &228 + - &231 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -13966,7 +14521,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -14020,7 +14575,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &239 + '301': &242 description: Moved permanently content: application/json: @@ -14042,7 +14597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &443 + - &446 name: all description: If `true`, show notifications marked as read. in: query @@ -14050,7 +14605,7 @@ paths: schema: type: boolean default: false - - &444 + - &447 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14059,8 +14614,8 @@ paths: schema: type: boolean default: false - - *59 - - &445 + - *62 + - &448 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: @@ -14085,14 +14640,14 @@ paths: application/json: schema: type: array - items: &81 + items: &84 title: Thread description: Thread type: object properties: id: type: string - repository: &105 + repository: &108 title: Minimal Repository description: Minimal Repository type: object @@ -14431,7 +14986,7 @@ paths: type: boolean examples: - false - security_and_analysis: &193 + security_and_analysis: &196 type: - object - 'null' @@ -14578,7 +15133,7 @@ paths: - url - subscription_url examples: - default: &446 + default: &449 value: - id: '1' repository: @@ -14744,7 +15299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &82 + - &85 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 @@ -14758,7 +15313,7 @@ paths: description: Response content: application/json: - schema: *81 + schema: *84 examples: default: value: @@ -14860,7 +15415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *82 + - *85 responses: '205': description: Reset Content @@ -14882,7 +15437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *82 + - *85 responses: '204': description: No content @@ -14905,13 +15460,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *82 + - *85 responses: '200': description: Response content: application/json: - schema: &83 + schema: &86 title: Thread Subscription description: Thread Subscription type: object @@ -14955,7 +15510,7 @@ paths: - url - subscribed examples: - default: &84 + default: &87 value: subscribed: true ignored: false @@ -14986,7 +15541,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *82 + - *85 requestBody: required: false content: @@ -15007,9 +15562,9 @@ paths: description: Response content: application/json: - schema: *83 + schema: *86 examples: - default: *84 + default: *87 '304': *35 '403': *27 '401': *23 @@ -15032,7 +15587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *82 + - *85 responses: '204': description: Response @@ -15127,9 +15682,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: &552 + default: &555 value: - login: github id: 1 @@ -15174,7 +15729,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - &86 + - &89 name: org description: The organization name. The name is not case sensitive. in: path @@ -15186,7 +15741,7 @@ paths: description: Response content: application/json: - schema: &87 + schema: &90 title: Organization Full description: Organization Full type: object @@ -15535,7 +16090,7 @@ paths: - updated_at - archived_at examples: - default-response: &88 + default-response: &91 value: login: github id: 1 @@ -15625,7 +16180,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *86 + - *89 requestBody: required: false content: @@ -15838,18 +16393,18 @@ paths: description: Response content: application/json: - schema: *87 + schema: *90 examples: - default: *88 + default: *91 '422': description: Validation failed content: application/json: schema: oneOf: - - *89 - - *90 - '409': &125 + - *92 + - *93 + '409': &128 description: Conflict content: application/json: @@ -15876,9 +16431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *86 + - *89 responses: - '202': *91 + '202': *94 '404': *6 '403': *27 x-github: @@ -15901,7 +16456,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -15948,7 +16503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -15966,7 +16521,7 @@ paths: type: integer repository_cache_usages: type: array - items: &244 + items: &247 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16024,13 +16579,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *86 + - *89 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &92 + schema: &95 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16044,7 +16599,7 @@ paths: required: - include_claim_keys examples: - default: &93 + default: &96 value: include_claim_keys: - repo @@ -16066,20 +16621,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 responses: '201': description: Empty response content: application/json: - schema: &114 + schema: &117 title: Empty Object description: An object without any properties. type: object @@ -16109,7 +16664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -16118,7 +16673,7 @@ paths: schema: type: object properties: - enabled_repositories: &94 + enabled_repositories: &97 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16131,7 +16686,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: &95 + allowed_actions: &98 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16139,7 +16694,7 @@ paths: - all - local_only - selected - selected_actions_url: &250 + selected_actions_url: &253 type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` @@ -16170,7 +16725,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16181,8 +16736,8 @@ paths: schema: type: object properties: - enabled_repositories: *94 - allowed_actions: *95 + enabled_repositories: *97 + allowed_actions: *98 required: - enabled_repositories examples: @@ -16209,7 +16764,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -16227,9 +16782,9 @@ paths: type: number repositories: type: array - items: *54 + items: *57 examples: - default: &546 + default: &549 value: total_count: 1 repositories: @@ -16369,7 +16924,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16413,8 +16968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *86 - - &96 + - *89 + - &99 name: repository_id description: The unique identifier of the repository. in: path @@ -16442,8 +16997,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *86 - - *96 + - *89 + - *99 responses: '204': description: Response @@ -16466,13 +17021,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &97 + schema: &100 type: object properties: github_owned_allowed: @@ -16494,7 +17049,7 @@ paths: items: type: string examples: - default: &98 + default: &101 value: github_owned_allowed: true verified_allowed: false @@ -16519,7 +17074,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -16527,9 +17082,9 @@ paths: required: false content: application/json: - schema: *97 + schema: *100 examples: - selected_actions: *98 + selected_actions: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16551,23 +17106,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &254 + schema: &257 type: object properties: - default_workflow_permissions: &99 + default_workflow_permissions: &102 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &100 + can_approve_pull_request_reviews: &103 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -16575,7 +17130,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &101 + default: &104 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -16600,7 +17155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Success response @@ -16608,13 +17163,13 @@ paths: required: false content: application/json: - schema: &255 + schema: &258 type: object properties: - default_workflow_permissions: *99 - can_approve_pull_request_reviews: *100 + default_workflow_permissions: *102 + can_approve_pull_request_reviews: *103 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16634,7 +17189,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *86 + - *89 - *17 - *18 - name: visible_to_repository @@ -16659,7 +17214,7 @@ paths: type: number runner_groups: type: array - items: &102 + items: &105 type: object properties: id: @@ -16772,7 +17327,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -16842,9 +17397,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: &104 + default: &107 value: id: 2 name: octo-runner-group @@ -16879,8 +17434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *86 - - &103 + - *89 + - &106 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -16892,7 +17447,7 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: default: value: @@ -16928,8 +17483,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -16980,9 +17535,9 @@ paths: description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *104 + default: *107 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17001,8 +17556,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *86 - - *103 + - *89 + - *106 responses: '204': description: Response @@ -17025,8 +17580,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 + - *89 + - *106 - *18 - *17 responses: @@ -17044,9 +17599,9 @@ paths: type: number repositories: type: array - items: *105 + items: *108 examples: - default: &538 + default: &541 value: total_count: 1 repositories: @@ -17298,8 +17853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -17343,9 +17898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 - - *96 + - *89 + - *106 + - *99 responses: '204': description: Response @@ -17367,9 +17922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *86 - - *103 - - *96 + - *89 + - *106 + - *99 responses: '204': description: Response @@ -17392,8 +17947,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 - *17 - *18 responses: @@ -17411,7 +17966,7 @@ paths: type: number runners: type: array - items: &107 + items: &110 title: Self hosted runners description: A self hosted runner type: object @@ -17445,7 +18000,7 @@ paths: type: boolean labels: type: array - items: &110 + items: &113 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -17473,7 +18028,7 @@ paths: - busy - labels examples: - default: &108 + default: &111 value: total_count: 2 runners: @@ -17530,8 +18085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 + - *106 requestBody: required: true content: @@ -17575,9 +18130,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *86 - - *103 - - &106 + - *89 + - *106 + - &109 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -17605,9 +18160,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *86 - - *103 + - *89 - *106 + - *109 responses: '204': description: Response @@ -17637,7 +18192,7 @@ paths: in: query schema: type: string - - *86 + - *89 - *17 - *18 responses: @@ -17655,9 +18210,9 @@ paths: type: integer runners: type: array - items: *107 + items: *110 examples: - default: *108 + default: *111 headers: Link: *37 x-github: @@ -17681,7 +18236,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -17689,7 +18244,7 @@ paths: application/json: schema: type: array - items: &256 + items: &259 title: Runner Application description: Runner Application type: object @@ -17714,7 +18269,7 @@ paths: - download_url - filename examples: - default: &257 + default: &260 value: - os: osx architecture: x64 @@ -17757,7 +18312,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -17800,7 +18355,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &258 + '201': &261 description: Response content: application/json: @@ -17810,7 +18365,7 @@ paths: - runner - encoded_jit_config properties: - runner: *107 + runner: *110 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17866,13 +18421,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *86 + - *89 responses: '201': description: Response content: application/json: - schema: &109 + schema: &112 title: Authentication Token description: Authentication Token type: object @@ -17896,7 +18451,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *54 + items: *57 single_file: type: - string @@ -17914,7 +18469,7 @@ paths: - token - expires_at examples: - default: &259 + default: &262 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -17945,15 +18500,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *86 + - *89 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: &260 + default: &263 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -17978,16 +18533,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: '200': description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: &261 + default: &264 value: id: 23 name: MBP @@ -18027,8 +18582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: '204': description: Response @@ -18053,10 +18608,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: - '200': &111 + '200': &114 description: Response content: application/json: @@ -18070,7 +18625,7 @@ paths: type: integer labels: type: array - items: *110 + items: *113 examples: default: value: @@ -18109,8 +18664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 requestBody: required: true content: @@ -18134,7 +18689,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18158,8 +18713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 requestBody: required: true content: @@ -18184,7 +18739,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18208,10 +18763,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 + - *89 + - *109 responses: - '200': &262 + '200': &265 description: Response content: application/json: @@ -18225,7 +18780,7 @@ paths: type: integer labels: type: array - items: *110 + items: *113 examples: default: value: @@ -18266,9 +18821,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *86 - - *106 - - &263 + - *89 + - *109 + - &266 name: name description: The name of a self-hosted runner's custom label. in: path @@ -18276,7 +18831,7 @@ paths: schema: type: string responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -18301,7 +18856,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -18319,7 +18874,7 @@ paths: type: integer secrets: type: array - items: &112 + items: &115 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -18394,13 +18949,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &275 + schema: &278 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -18435,7 +18990,7 @@ paths: - key_id - key examples: - default: &276 + default: &279 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -18460,8 +19015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *86 - - &113 + - *89 + - &116 name: secret_name description: The name of the secret. in: path @@ -18473,7 +19028,7 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: default: value: @@ -18503,8 +19058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -18559,7 +19114,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -18585,8 +19140,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -18612,8 +19167,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -18631,9 +19186,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: &117 + default: &120 value: total_count: 1 repositories: @@ -18725,8 +19280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -18778,8 +19333,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -18812,8 +19367,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -18845,8 +19400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *86 - - &249 + - *89 + - &252 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)." @@ -18870,7 +19425,7 @@ paths: type: integer variables: type: array - items: &115 + items: &118 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -18960,7 +19515,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *86 + - *89 requestBody: required: true content: @@ -19008,7 +19563,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -19033,8 +19588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *86 - - &116 + - *89 + - &119 name: name description: The name of the variable. in: path @@ -19046,7 +19601,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *118 examples: default: value: @@ -19076,8 +19631,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 requestBody: required: true content: @@ -19139,8 +19694,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 responses: '204': description: Response @@ -19166,8 +19721,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - *18 - *17 responses: @@ -19185,9 +19740,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19213,8 +19768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 requestBody: required: true content: @@ -19263,8 +19818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - name: repository_id in: path required: true @@ -19298,8 +19853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *86 - - *116 + - *89 + - *119 - name: repository_id in: path required: true @@ -19335,7 +19890,7 @@ paths: - *17 - *41 - *42 - - *86 + - *89 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -19376,7 +19931,7 @@ paths: repository_id: type: integer examples: - default: &289 + default: &292 value: attestations: - bundle: @@ -19483,7 +20038,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -19495,7 +20050,7 @@ paths: type: array items: *4 examples: - default: &161 + default: &164 value: - login: octocat id: 1 @@ -19533,8 +20088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *86 - - &118 + - *89 + - &121 name: username description: The handle for the GitHub user account. in: path @@ -19565,8 +20120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -19586,8 +20141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -19612,18 +20167,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *86 - - &314 + - *89 + - &317 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: &121 + schema: &124 type: string description: The name of the tool used to generate the code scanning analysis. - - &315 + - &318 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 @@ -19631,7 +20186,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &122 + schema: &125 type: - string - 'null' @@ -19647,7 +20202,7 @@ paths: be returned. in: query required: false - schema: &317 + schema: &320 type: string description: State of a code scanning alert. enum: @@ -19670,7 +20225,7 @@ paths: be returned. in: query required: false - schema: &318 + schema: &321 type: string description: Severity of a code scanning alert. enum: @@ -19696,13 +20251,13 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: &319 + instances_url: &322 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &123 + state: &126 type: - string - 'null' @@ -19712,13 +20267,13 @@ paths: - dismissed - fixed - - fixed_at: *119 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: &320 + dismissed_at: *123 + dismissed_reason: &323 type: - string - 'null' @@ -19729,14 +20284,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &321 + dismissed_comment: &324 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &322 + rule: &325 type: object properties: id: @@ -19797,26 +20352,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &323 + tool: &326 type: object properties: - name: *121 + name: *124 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *122 - most_recent_instance: &324 + guid: *125 + most_recent_instance: &327 type: object properties: - ref: &316 + ref: &319 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &330 + analysis_key: &333 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19827,13 +20382,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &331 + category: &334 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: *123 + state: *126 commit_sha: type: string message: @@ -20121,7 +20676,7 @@ paths: headers: Link: *37 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20143,7 +20698,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *86 + - *89 - name: target_type in: query description: The target type of the code security configuration @@ -20171,7 +20726,7 @@ paths: application/json: schema: type: array - items: &124 + items: &127 type: object description: A code security configuration properties: @@ -20410,7 +20965,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *86 + - *89 requestBody: required: true content: @@ -20582,9 +21137,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *124 + schema: *127 examples: - default: &126 + default: &129 value: id: 1325 target_type: organization @@ -20630,7 +21185,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *86 + - *89 responses: '200': description: Response @@ -20650,7 +21205,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *124 + configuration: *127 examples: default: value: @@ -20734,7 +21289,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *86 + - *89 requestBody: required: true content: @@ -20757,12 +21312,12 @@ paths: - 32 - 91 responses: - '204': &128 + '204': &131 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20784,8 +21339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *86 - - &127 + - *89 + - &130 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20797,9 +21352,9 @@ paths: description: Response content: application/json: - schema: *124 + schema: *127 examples: - default: *126 + default: *129 '304': *35 '403': *27 '404': *6 @@ -20823,8 +21378,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -20976,7 +21531,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *124 + schema: *127 examples: default: value: @@ -21027,14 +21582,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 responses: - '204': *128 + '204': *131 '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21058,8 +21613,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -21098,7 +21653,7 @@ paths: - 32 - 91 responses: - '202': *91 + '202': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21122,8 +21677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *86 - - *127 + - *89 + - *130 requestBody: required: true content: @@ -21163,12 +21718,12 @@ paths: - none - private_and_internal - public - configuration: *124 + configuration: *127 examples: default: value: default_for_new_repos: all - configuration: *126 + configuration: *129 '403': *27 '404': *6 x-github: @@ -21192,8 +21747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *86 - - *127 + - *89 + - *130 - 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)." @@ -21336,7 +21891,7 @@ paths: parameters: - *17 - *18 - - *86 + - *89 responses: '200': description: Response @@ -21352,7 +21907,7 @@ paths: type: integer codespaces: type: array - items: &162 + items: &165 type: object title: Codespace description: A codespace. @@ -21383,11 +21938,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *105 + repository: *108 machine: anyOf: - type: 'null' - - &344 + - &347 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -21674,7 +22229,7 @@ paths: - pulls_url - recent_folders examples: - default: &163 + default: &166 value: total_count: 3 codespaces: @@ -22106,7 +22661,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *86 + - *89 deprecated: true requestBody: required: true @@ -22173,7 +22728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *86 + - *89 deprecated: true requestBody: required: true @@ -22228,7 +22783,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *86 + - *89 requestBody: required: true content: @@ -22280,7 +22835,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -22298,7 +22853,7 @@ paths: type: integer secrets: type: array - items: &129 + items: &132 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -22339,7 +22894,7 @@ paths: - updated_at - visibility examples: - default: &345 + default: &348 value: total_count: 2 secrets: @@ -22371,13 +22926,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &346 + schema: &349 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -22412,7 +22967,7 @@ paths: - key_id - key examples: - default: &347 + default: &350 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22435,16 +22990,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '200': description: Response content: application/json: - schema: *129 + schema: *132 examples: - default: &349 + default: &352 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -22471,8 +23026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -22527,7 +23082,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -22553,8 +23108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -22579,8 +23134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -22598,9 +23153,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 '404': *6 x-github: githubCloudOnly: false @@ -22622,8 +23177,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -22673,8 +23228,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -22707,8 +23262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -22747,7 +23302,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *86 + - *89 responses: '200': description: OK @@ -22887,7 +23442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *86 + - *89 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -22910,9 +23465,9 @@ paths: currently being billed. seats: type: array - items: *130 + items: *133 examples: - default: *131 + default: *134 headers: Link: *37 '500': *39 @@ -22950,7 +23505,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23028,7 +23583,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23109,7 +23664,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23187,7 +23742,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *86 + - *89 requestBody: content: application/json: @@ -23243,6 +23798,74 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - *89 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -23268,7 +23891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *86 + - *89 - 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`). @@ -23300,9 +23923,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: *132 + default: *135 '500': *39 '401': *23 '403': *27 @@ -23328,18 +23951,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *86 - - *133 - - *134 - - *135 + - *89 - *136 - *137 - *138 + - *139 + - *140 + - *141 - *40 - *41 - *42 - - *139 - - *140 + - *142 + - *143 - *17 responses: '200': @@ -23348,9 +23971,9 @@ paths: application/json: schema: type: array - items: *141 + items: *144 examples: - default: *142 + default: *145 '304': *35 '400': *14 '403': *27 @@ -23376,7 +23999,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *86 + - *89 - *17 - *18 responses: @@ -23394,7 +24017,7 @@ paths: type: integer secrets: type: array - items: &143 + items: &146 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -23467,13 +24090,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &372 + schema: &375 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -23492,7 +24115,7 @@ paths: - key_id - key examples: - default: &373 + default: &376 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23515,14 +24138,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '200': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -23550,8 +24173,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -23606,7 +24229,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -23630,8 +24253,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 responses: '204': description: Response @@ -23655,8 +24278,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - *18 - *17 responses: @@ -23674,9 +24297,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *117 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23697,8 +24320,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 requestBody: required: true content: @@ -23748,8 +24371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -23780,8 +24403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *86 - - *113 + - *89 + - *116 - name: repository_id in: path required: true @@ -23811,7 +24434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -23819,7 +24442,7 @@ paths: application/json: schema: type: array - items: &174 + items: &177 title: Package description: A software package type: object @@ -23872,7 +24495,7 @@ paths: repository: anyOf: - type: 'null' - - *105 + - *108 created_at: type: string format: date-time @@ -23890,7 +24513,7 @@ paths: - created_at - updated_at examples: - default: &175 + default: &178 value: - id: 197 name: hello_docker @@ -23968,7 +24591,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *86 + - *89 - *17 - *18 responses: @@ -23978,7 +24601,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: 200-response: value: @@ -24047,7 +24670,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24057,7 +24680,7 @@ paths: application/json: schema: type: array - items: &155 + items: &158 title: Organization Invitation description: Organization Invitation type: object @@ -24111,7 +24734,7 @@ paths: - invitation_teams_url - node_id examples: - default: &156 + default: &159 value: - id: 1 login: monalisa @@ -24166,7 +24789,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24176,7 +24799,7 @@ paths: application/json: schema: type: array - items: &144 + items: &147 title: Org Hook description: Org Hook type: object @@ -24299,7 +24922,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *86 + - *89 requestBody: required: true content: @@ -24361,9 +24984,9 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: - default: &145 + default: &148 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -24410,8 +25033,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *86 - - &146 + - *89 + - &149 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. @@ -24424,9 +25047,9 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: - default: *145 + default: *148 '404': *6 x-github: githubCloudOnly: false @@ -24453,8 +25076,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 requestBody: required: false content: @@ -24500,7 +25123,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: default: value: @@ -24539,8 +25162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 responses: '204': description: Response @@ -24567,8 +25190,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *86 - - *146 + - *89 + - *149 responses: '200': description: Response @@ -24598,8 +25221,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *86 - - *146 + - *89 + - *149 requestBody: required: false content: @@ -24649,10 +25272,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *17 - - *147 + - *150 - name: redelivery in: query required: false @@ -24665,9 +25288,9 @@ paths: application/json: schema: type: array - items: *148 + items: *151 examples: - default: *149 + default: *152 '400': *14 '422': *15 x-github: @@ -24692,17 +25315,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *16 responses: '200': description: Response content: application/json: - schema: *150 + schema: *153 examples: - default: *151 + default: *154 '400': *14 '422': *15 x-github: @@ -24727,11 +25350,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 - *16 responses: - '202': *91 + '202': *94 '400': *14 '422': *15 x-github: @@ -24757,8 +25380,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *86 - - *146 + - *89 + - *149 responses: '204': description: Response @@ -24782,7 +25405,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *86 + - *89 responses: '200': description: Response @@ -24790,7 +25413,7 @@ paths: application/json: schema: *20 examples: - default: &411 + default: &414 value: id: 1 account: @@ -24859,7 +25482,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *86 + - *89 - *17 - *18 responses: @@ -24948,7 +25571,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -24956,12 +25579,12 @@ paths: application/json: schema: anyOf: - - &153 + - &156 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &152 + limit: &155 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -24989,7 +25612,7 @@ paths: properties: {} additionalProperties: false examples: - default: &154 + default: &157 value: limit: collaborators_only origin: organization @@ -25013,18 +25636,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: application/json: - schema: &412 + schema: &415 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *152 + limit: *155 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -25049,9 +25672,9 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: - default: *154 + default: *157 '422': *15 x-github: githubCloudOnly: false @@ -25069,7 +25692,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *86 + - *89 responses: '204': description: Response @@ -25093,7 +25716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *86 + - *89 - *17 - *18 - name: role @@ -25127,9 +25750,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 '404': *6 @@ -25152,7 +25775,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *86 + - *89 requestBody: required: false content: @@ -25206,7 +25829,7 @@ paths: description: Response content: application/json: - schema: *155 + schema: *158 examples: default: value: @@ -25260,8 +25883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *86 - - &157 + - *89 + - &160 name: invitation_id description: The unique identifier of the invitation. in: path @@ -25291,8 +25914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *86 - - *157 + - *89 + - *160 - *17 - *18 responses: @@ -25302,9 +25925,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: &173 + default: &176 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -25349,7 +25972,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *86 + - *89 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -25379,7 +26002,7 @@ paths: - closed - all default: open - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -25392,7 +26015,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -25402,9 +26025,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: *160 + default: *163 headers: Link: *37 '404': *6 @@ -25426,7 +26049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *86 + - *89 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -25462,7 +26085,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '422': *15 @@ -25482,8 +26105,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response if requester is an organization member and user is @@ -25514,8 +26137,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -25541,8 +26164,8 @@ paths: parameters: - *17 - *18 - - *86 - - *118 + - *89 + - *121 responses: '200': description: Response @@ -25558,9 +26181,9 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: - default: *163 + default: *166 '304': *35 '500': *39 '401': *23 @@ -25585,9 +26208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *86 - - *118 - - &164 + - *89 + - *121 + - &167 name: codespace_name in: path required: true @@ -25595,7 +26218,7 @@ paths: schema: type: string responses: - '202': *91 + '202': *94 '304': *35 '500': *39 '401': *23 @@ -25620,17 +26243,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *86 - - *118 - - *164 + - *89 + - *121 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: &343 + default: &346 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -25800,14 +26423,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -25875,14 +26498,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '200': description: Response content: application/json: - schema: &165 + schema: &168 title: Org Membership description: Org Membership type: object @@ -25915,7 +26538,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *85 + organization: *88 user: anyOf: - type: 'null' @@ -25935,7 +26558,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &166 + response-if-user-has-an-active-admin-membership-with-organization: &169 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -26003,8 +26626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 requestBody: required: false content: @@ -26032,9 +26655,9 @@ paths: description: Response content: application/json: - schema: *165 + schema: *168 examples: - response-if-user-already-had-membership-with-organization: *166 + response-if-user-already-had-membership-with-organization: *169 '422': *15 '403': *27 x-github: @@ -26055,8 +26678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -26081,7 +26704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *86 + - *89 - *17 - *18 - name: exclude @@ -26103,7 +26726,7 @@ paths: application/json: schema: type: array - items: &167 + items: &170 title: Migration description: A migration. type: object @@ -26145,7 +26768,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *54 + items: *57 url: type: string format: uri @@ -26360,7 +26983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *86 + - *89 requestBody: required: true content: @@ -26441,7 +27064,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -26619,8 +27242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *86 - - &168 + - *89 + - &171 name: migration_id description: The unique identifier of the migration. in: path @@ -26648,7 +27271,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -26817,8 +27440,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *86 - - *168 + - *89 + - *171 responses: '302': description: Response @@ -26839,8 +27462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *86 - - *168 + - *89 + - *171 responses: '204': description: Response @@ -26863,9 +27486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *86 - - *168 - - &551 + - *89 + - *171 + - &554 name: repo_name description: repo_name parameter in: path @@ -26892,8 +27515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *86 - - *168 + - *89 + - *171 - *17 - *18 responses: @@ -26903,9 +27526,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: &180 + default: &183 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -27042,7 +27665,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response - list of organization roles @@ -27058,7 +27681,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &171 + items: &174 title: Organization Role description: Organization roles type: object @@ -27183,8 +27806,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -27209,9 +27832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *86 - - *169 - - &170 + - *89 + - *172 + - &173 name: role_id description: The unique identifier of the role. in: path @@ -27246,9 +27869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *86 - - *169 - - *170 + - *89 + - *172 + - *173 responses: '204': description: Response @@ -27273,8 +27896,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -27299,9 +27922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *86 - - *118 - - *170 + - *89 + - *121 + - *173 responses: '204': description: Response @@ -27331,9 +27954,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *86 - - *118 - - *170 + - *89 + - *121 + - *173 responses: '204': description: Response @@ -27361,14 +27984,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27418,8 +28041,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 - *17 - *18 responses: @@ -27488,7 +28111,7 @@ paths: parent: anyOf: - type: 'null' - - *172 + - *175 required: - id - node_id @@ -27502,7 +28125,7 @@ paths: - slug - parent examples: - default: *173 + default: *176 headers: Link: *37 '404': @@ -27531,8 +28154,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *86 - - *170 + - *89 + - *173 - *17 - *18 responses: @@ -27664,7 +28287,7 @@ paths: - type - url examples: - default: *161 + default: *164 headers: Link: *37 '404': @@ -27688,7 +28311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *86 + - *89 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -27712,7 +28335,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -27737,8 +28360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *86 - - *118 + - *89 + - *121 requestBody: required: false content: @@ -27795,8 +28418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -27853,8 +28476,8 @@ paths: - docker - nuget - container - - *86 - - &553 + - *89 + - &556 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -27890,12 +28513,12 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *175 + default: *178 '403': *27 '401': *23 - '400': &555 + '400': &558 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -27917,7 +28540,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &176 + - &179 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 @@ -27935,20 +28558,20 @@ paths: - docker - nuget - container - - &177 + - &180 name: package_name description: The name of the package. in: path required: true schema: type: string - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -28000,9 +28623,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 responses: '204': description: Response @@ -28034,9 +28657,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 - name: token description: package token schema: @@ -28068,9 +28691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *176 - - *177 - - *86 + - *179 + - *180 + - *89 - *18 - *17 - name: state @@ -28090,7 +28713,7 @@ paths: application/json: schema: type: array - items: &178 + items: &181 title: Package Version description: A version of a software package type: object @@ -28225,10 +28848,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - - &179 + - *179 + - *180 + - *89 + - &182 name: package_version_id description: Unique identifier of the package version. in: path @@ -28240,7 +28863,7 @@ paths: description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -28276,10 +28899,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - *179 + - *180 + - *89 + - *182 responses: '204': description: Response @@ -28311,10 +28934,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *176 - - *177 - - *86 - *179 + - *180 + - *89 + - *182 responses: '204': description: Response @@ -28341,10 +28964,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *86 + - *89 - *17 - *18 - - &181 + - &184 name: sort description: The property by which to sort the results. in: query @@ -28355,7 +28978,7 @@ paths: - created_at default: created_at - *40 - - &182 + - &185 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -28367,7 +28990,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &183 + - &186 name: repository description: The name of the repository to use to filter the results. in: query @@ -28376,7 +28999,7 @@ paths: type: string examples: - Hello-World - - &184 + - &187 name: permission description: The permission to use to filter the results. in: query @@ -28385,7 +29008,7 @@ paths: type: string examples: - issues_read - - &185 + - &188 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) @@ -28395,7 +29018,7 @@ paths: schema: type: string format: date-time - - &186 + - &189 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) @@ -28547,7 +29170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *86 + - *89 requestBody: required: true content: @@ -28593,7 +29216,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *91 + '202': *94 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28614,7 +29237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *86 + - *89 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -28655,7 +29278,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *128 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28676,7 +29299,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *86 + - *89 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -28696,9 +29319,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -28721,16 +29344,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *86 + - *89 - *17 - *18 - - *181 - - *40 - - *182 - - *183 - *184 + - *40 - *185 - *186 + - *187 + - *188 + - *189 responses: '500': *39 '422': *15 @@ -28867,7 +29490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *86 + - *89 requestBody: required: true content: @@ -28904,7 +29527,7 @@ paths: responses: '500': *39 '404': *6 - '202': *91 + '202': *94 '403': *27 '422': *15 x-github: @@ -28927,7 +29550,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *86 + - *89 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -28957,7 +29580,7 @@ paths: responses: '500': *39 '404': *6 - '204': *128 + '204': *131 '403': *27 '422': *15 x-github: @@ -28979,7 +29602,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *86 + - *89 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -28998,9 +29621,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -29022,7 +29645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *86 + - *89 - name: state description: Indicates the state of the projects to return. in: query @@ -29043,7 +29666,7 @@ paths: application/json: schema: type: array - items: &187 + items: &190 title: Project description: Projects are a way to organize columns and cards of work. @@ -29196,7 +29819,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *86 + - *89 requestBody: required: true content: @@ -29222,7 +29845,7 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: default: value: @@ -29260,7 +29883,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &236 + '410': &239 description: Gone content: application/json: @@ -29284,7 +29907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response @@ -29292,7 +29915,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -29360,7 +29983,7 @@ paths: - property_name - value_type examples: - default: &189 + default: &192 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -29401,7 +30024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *86 + - *89 requestBody: required: true content: @@ -29412,7 +30035,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *188 + items: *191 minItems: 1 maxItems: 100 required: @@ -29442,9 +30065,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '403': *27 '404': *6 x-github: @@ -29465,8 +30088,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *86 - - &190 + - *89 + - &193 name: custom_property_name description: The custom property name in: path @@ -29478,9 +30101,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: - default: &191 + default: &194 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -29513,8 +30136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *86 - - *190 + - *89 + - *193 requestBody: required: true content: @@ -29579,9 +30202,9 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: - default: *191 + default: *194 '403': *27 '404': *6 x-github: @@ -29604,10 +30227,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *86 - - *190 + - *89 + - *193 responses: - '204': *128 + '204': *131 '403': *27 '404': *6 x-github: @@ -29628,7 +30251,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *86 + - *89 - *17 - *18 - name: repository_query @@ -29669,7 +30292,7 @@ paths: - octocat/Hello-World properties: type: array - items: &192 + items: &195 title: Custom Property Value description: Custom property name and associated value type: object @@ -29739,7 +30362,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *86 + - *89 requestBody: required: true content: @@ -29759,7 +30382,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *192 + items: *195 required: - repository_names - properties @@ -29800,7 +30423,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *86 + - *89 - *17 - *18 responses: @@ -29812,7 +30435,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -29831,8 +30454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response if user is a public member @@ -29856,8 +30479,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -29878,8 +30501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *86 - - *118 + - *89 + - *121 responses: '204': description: Response @@ -29903,7 +30526,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *86 + - *89 - name: type description: Specifies the types of repositories you want returned. in: query @@ -29949,9 +30572,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -29972,7 +30595,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *86 + - *89 requestBody: required: true content: @@ -30154,7 +30777,7 @@ paths: description: Response content: application/json: - schema: &238 + schema: &241 title: Full Repository description: Full Repository type: object @@ -30500,7 +31123,7 @@ paths: template_repository: anyOf: - type: 'null' - - *54 + - *57 temp_clone_token: type: - string @@ -30600,13 +31223,13 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 organization: anyOf: - type: 'null' - *4 - parent: *54 - source: *54 + parent: *57 + source: *57 forks: type: integer master_branch: @@ -30619,7 +31242,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &362 + code_of_conduct: &365 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -30649,7 +31272,7 @@ paths: - key - name - html_url - security_and_analysis: *193 + security_and_analysis: *196 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -30733,7 +31356,7 @@ paths: - network_count - subscribers_count examples: - default: &240 + default: &243 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31251,10 +31874,10 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - *17 - *18 - - &492 + - &495 name: targets description: | A comma-separated list of rule targets to filter by. @@ -31273,7 +31896,7 @@ paths: application/json: schema: type: array - items: &200 + items: &203 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -31306,7 +31929,7 @@ paths: source: type: string description: The name of the source - enforcement: &196 + enforcement: &199 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -31319,7 +31942,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &197 + items: &200 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -31385,7 +32008,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &194 + - &197 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -31409,7 +32032,7 @@ paths: match. items: type: string - - &198 + - &201 title: Organization ruleset conditions type: object description: |- @@ -31422,7 +32045,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -31456,7 +32079,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -31478,7 +32101,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *194 + - *197 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -31491,7 +32114,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &195 + items: &198 title: Repository ruleset property targeting definition type: object @@ -31524,7 +32147,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *195 + items: *198 required: - repository_property type: @@ -31532,12 +32155,12 @@ paths: - object rules: type: array - items: &199 + items: &202 title: Repository Rule type: object description: A repository rule. oneOf: - - &474 + - &477 title: creation description: Only allow users with bypass permission to create matching refs. @@ -31549,7 +32172,7 @@ paths: type: string enum: - creation - - &475 + - &478 title: update description: Only allow users with bypass permission to update matching refs. @@ -31570,7 +32193,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &477 + - &480 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -31582,7 +32205,7 @@ paths: type: string enum: - deletion - - &478 + - &481 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -31594,7 +32217,7 @@ paths: type: string enum: - required_linear_history - - &479 + - &482 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -31672,7 +32295,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &480 + - &483 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -31696,7 +32319,7 @@ paths: type: string required: - required_deployment_environments - - &481 + - &484 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -31708,7 +32331,7 @@ paths: type: string enum: - required_signatures - - &482 + - &485 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -31754,7 +32377,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &483 + - &486 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -31802,7 +32425,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &484 + - &487 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -31814,7 +32437,7 @@ paths: type: string enum: - non_fast_forward - - &485 + - &488 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -31850,7 +32473,7 @@ paths: required: - operator - pattern - - &486 + - &489 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -31886,7 +32509,7 @@ paths: required: - operator - pattern - - &487 + - &490 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -31922,7 +32545,7 @@ paths: required: - operator - pattern - - &488 + - &491 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -31958,7 +32581,7 @@ paths: required: - operator - pattern - - &489 + - &492 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -32084,7 +32707,7 @@ paths: maximum: 100 required: - max_file_size - - &490 + - &493 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -32134,7 +32757,7 @@ paths: - repository_id required: - workflows - - &491 + - &494 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -32247,7 +32870,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 requestBody: description: Request body required: true @@ -32267,16 +32890,16 @@ paths: - tag - push default: branch - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *198 + items: *200 + conditions: *201 rules: type: array description: An array of rules within the ruleset. - items: *199 + items: *202 required: - name - enforcement @@ -32314,9 +32937,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: &201 + default: &204 value: id: 21 name: super cool ruleset @@ -32370,8 +32993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *86 - - &493 + - *89 + - &496 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 @@ -32387,7 +33010,7 @@ paths: in: query schema: type: integer - - &494 + - &497 name: time_period description: |- The time period to filter by. @@ -32403,14 +33026,14 @@ paths: - week - month default: day - - &495 + - &498 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 - - &496 + - &499 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -32430,7 +33053,7 @@ paths: description: Response content: application/json: - schema: &497 + schema: &500 title: Rule Suites description: Response type: array @@ -32486,7 +33109,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &498 + default: &501 value: - id: 21 actor_id: 12 @@ -32529,8 +33152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *86 - - &499 + - *89 + - &502 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -32546,7 +33169,7 @@ paths: description: Response content: application/json: - schema: &500 + schema: &503 title: Rule Suite description: Response type: object @@ -32653,7 +33276,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &501 + default: &504 value: id: 21 actor_id: 12 @@ -32714,7 +33337,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32726,9 +33349,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *201 + default: *204 '404': *6 '500': *39 put: @@ -32746,7 +33369,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32771,16 +33394,16 @@ paths: - branch - tag - push - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *198 + items: *200 + conditions: *201 rules: description: An array of rules within the ruleset. type: array - items: *199 + items: *202 examples: default: value: @@ -32815,9 +33438,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *201 + default: *204 '404': *6 '500': *39 delete: @@ -32835,7 +33458,7 @@ paths: category: orgs subcategory: rules parameters: - - *86 + - *89 - name: ruleset_id description: The ID of the ruleset. in: path @@ -32863,15 +33486,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *86 - - *202 - - *203 - - *204 + - *89 - *205 + - *206 + - *207 + - *208 - *40 - *18 - *17 - - &503 + - &506 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 @@ -32881,7 +33504,7 @@ paths: required: false schema: type: string - - &504 + - &507 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 @@ -32891,9 +33514,9 @@ paths: required: false schema: type: string - - *206 - - *207 - - *208 + - *209 + - *210 + - *211 responses: '200': description: Response @@ -32901,13 +33524,13 @@ paths: application/json: schema: type: array - items: *209 + items: *212 examples: - default: *210 + default: *213 headers: Link: *37 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32929,7 +33552,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *86 + - *89 - *40 - name: sort description: The property to sort the results by. @@ -32973,7 +33596,7 @@ paths: application/json: schema: type: array - items: &510 + items: &513 description: A repository security advisory. type: object properties: @@ -33217,7 +33840,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 credits_detailed: type: - array @@ -33228,7 +33851,7 @@ paths: type: object properties: user: *4 - type: *211 + type: *214 state: type: string description: The state of the user's acceptance of the @@ -33254,7 +33877,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *158 + items: *161 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -33292,7 +33915,7 @@ paths: - private_fork additionalProperties: false examples: - default: &511 + default: &514 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -33674,7 +34297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *86 + - *89 responses: '200': description: Response @@ -33682,9 +34305,9 @@ paths: application/json: schema: type: array - items: *172 + items: *175 examples: - default: *173 + default: *176 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33707,8 +34330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -33733,8 +34356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -33760,13 +34383,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &569 + schema: &572 type: object properties: total_minutes_used: @@ -33836,7 +34459,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &570 + default: &573 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -33866,13 +34489,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &571 + schema: &574 type: object properties: total_gigabytes_bandwidth_used: @@ -33890,7 +34513,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &572 + default: &575 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -33916,13 +34539,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &573 + schema: &576 type: object properties: days_left_in_billing_cycle: @@ -33940,7 +34563,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &574 + default: &577 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -33950,6 +34573,75 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - *89 + - *172 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *52 + examples: + default: *53 + '500': *39 + '403': *27 + '404': *6 + '422': *54 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -33978,8 +34670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *86 - - *169 + - *89 + - *172 - 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`). @@ -34011,9 +34703,9 @@ paths: application/json: schema: type: array - items: *52 + items: *55 examples: - default: *132 + default: *135 '500': *39 '401': *23 '403': *27 @@ -34035,7 +34727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *86 + - *89 - *17 - *18 responses: @@ -34045,9 +34737,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 headers: Link: *37 '403': *27 @@ -34069,7 +34761,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *86 + - *89 requestBody: required: true content: @@ -34141,7 +34833,7 @@ paths: description: Response content: application/json: - schema: &212 + schema: &215 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -34215,7 +34907,7 @@ paths: parent: anyOf: - type: 'null' - - *172 + - *175 members_count: type: integer examples: @@ -34521,7 +35213,7 @@ paths: - repos_count - organization examples: - default: &213 + default: &216 value: id: 1 node_id: MDQ6VGVhbTE= @@ -34591,16 +35283,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *86 - - *169 + - *89 + - *172 responses: '200': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -34621,8 +35313,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *86 - - *169 + - *89 + - *172 requestBody: required: false content: @@ -34685,16 +35377,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '201': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 '422': *15 '403': *27 @@ -34719,8 +35411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *86 - - *169 + - *89 + - *172 responses: '204': description: Response @@ -34746,8 +35438,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *86 - - *169 + - *89 + - *172 - *40 - *17 - *18 @@ -34764,7 +35456,7 @@ paths: application/json: schema: type: array - items: &214 + items: &217 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -34855,7 +35547,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *56 + reactions: *59 required: - author - body @@ -34875,7 +35567,7 @@ paths: - updated_at - url examples: - default: &525 + default: &528 value: - author: login: octocat @@ -34949,8 +35641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *86 - - *169 + - *89 + - *172 requestBody: required: true content: @@ -34984,9 +35676,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: &215 + default: &218 value: author: login: octocat @@ -35058,9 +35750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *86 - - *169 - - &216 + - *89 + - *172 + - &219 name: discussion_number description: The number that identifies the discussion. in: path @@ -35072,9 +35764,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35096,9 +35788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: false content: @@ -35121,9 +35813,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: &526 + default: &529 value: author: login: octocat @@ -35193,9 +35885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 responses: '204': description: Response @@ -35221,9 +35913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 - *40 - *17 - *18 @@ -35234,7 +35926,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -35299,7 +35991,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *56 + reactions: *59 required: - author - body @@ -35314,7 +36006,7 @@ paths: - updated_at - url examples: - default: &527 + default: &530 value: - author: login: octocat @@ -35382,9 +36074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: true content: @@ -35406,9 +36098,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &218 + default: &221 value: author: login: octocat @@ -35474,10 +36166,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *86 - - *169 - - *216 - - &219 + - *89 + - *172 + - *219 + - &222 name: comment_number description: The number that identifies the comment. in: path @@ -35489,9 +36181,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35513,10 +36205,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 requestBody: required: true content: @@ -35538,9 +36230,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: &528 + default: &531 value: author: login: octocat @@ -35604,10 +36296,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 responses: '204': description: Response @@ -35633,10 +36325,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -35662,7 +36354,7 @@ paths: application/json: schema: type: array - items: &220 + items: &223 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -35706,7 +36398,7 @@ paths: - content - created_at examples: - default: &222 + default: &225 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -35756,10 +36448,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 + - *222 requestBody: required: true content: @@ -35792,9 +36484,9 @@ paths: team discussion comment content: application/json: - schema: *220 + schema: *223 examples: - default: &221 + default: &224 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -35823,9 +36515,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35848,11 +36540,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *86 - - *169 - - *216 + - *89 + - *172 - *219 - - &223 + - *222 + - &226 name: reaction_id description: The unique identifier of the reaction. in: path @@ -35884,9 +36576,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -35912,9 +36604,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -35940,9 +36632,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *86 - - *169 - - *216 + - *89 + - *172 + - *219 requestBody: required: true content: @@ -35974,16 +36666,16 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -36006,10 +36698,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *86 - - *169 - - *216 - - *223 + - *89 + - *172 + - *219 + - *226 responses: '204': description: Response @@ -36033,8 +36725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36044,9 +36736,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 x-github: @@ -36068,8 +36760,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *86 - - *169 + - *89 + - *172 - name: role description: Filters members returned by their role in the team. in: query @@ -36092,7 +36784,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -36122,15 +36814,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 responses: '200': description: Response content: application/json: - schema: &224 + schema: &227 title: Team Membership description: Team Membership type: object @@ -36158,7 +36850,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &529 + response-if-user-is-a-team-maintainer: &532 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -36194,9 +36886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 requestBody: required: false content: @@ -36221,9 +36913,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-users-membership-with-team-is-now-pending: &530 + response-if-users-membership-with-team-is-now-pending: &533 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -36258,9 +36950,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *86 - - *169 - - *118 + - *89 + - *172 + - *121 responses: '204': description: Response @@ -36286,8 +36978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36297,7 +36989,7 @@ paths: application/json: schema: type: array - items: &225 + items: &228 title: Team Project description: A team's access to a project. type: object @@ -36366,7 +37058,7 @@ paths: - updated_at - permissions examples: - default: &531 + default: &534 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36427,9 +37119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *86 - - *169 - - &226 + - *89 + - *172 + - &229 name: project_id description: The unique identifier of the project. in: path @@ -36441,9 +37133,9 @@ paths: description: Response content: application/json: - schema: *225 + schema: *228 examples: - default: &532 + default: &535 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -36503,9 +37195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *86 - - *169 - - *226 + - *89 + - *172 + - *229 requestBody: required: false content: @@ -36570,9 +37262,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *86 - - *169 - - *226 + - *89 + - *172 + - *229 responses: '204': description: Response @@ -36596,8 +37288,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -36607,9 +37299,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -36638,16 +37330,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &533 + schema: &536 title: Team Repository description: A team's access to a repository. type: object @@ -36673,7 +37365,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 forks: type: integer permissions: @@ -37288,10 +37980,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 requestBody: required: false content: @@ -37336,10 +38028,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *86 - - *169 - - *227 - - *228 + - *89 + - *172 + - *230 + - *231 responses: '204': description: Response @@ -37363,8 +38055,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *86 - - *169 + - *89 + - *172 - *17 - *18 responses: @@ -37374,9 +38066,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - response-if-child-teams-exist: &534 + response-if-child-teams-exist: &537 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -37429,7 +38121,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *86 + - *89 - name: security_product in: path description: The security feature to enable or disable. @@ -37500,7 +38192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &229 + - &232 name: card_id description: The unique identifier of the card. in: path @@ -37512,7 +38204,7 @@ paths: description: Response content: application/json: - schema: &230 + schema: &233 title: Project Card description: Project cards represent a scope of work. type: object @@ -37587,7 +38279,7 @@ paths: - created_at - updated_at examples: - default: &231 + default: &234 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -37637,7 +38329,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *229 + - *232 requestBody: required: false content: @@ -37667,9 +38359,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *233 examples: - default: *231 + default: *234 '304': *35 '403': *27 '401': *23 @@ -37690,7 +38382,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *229 + - *232 responses: '204': description: Response @@ -37728,7 +38420,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *229 + - *232 requestBody: required: true content: @@ -37835,7 +38527,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &232 + - &235 name: column_id description: The unique identifier of the column. in: path @@ -37847,7 +38539,7 @@ paths: description: Response content: application/json: - schema: &233 + schema: &236 title: Project Column description: Project columns contain cards of work. type: object @@ -37901,7 +38593,7 @@ paths: - created_at - updated_at examples: - default: &234 + default: &237 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -37930,7 +38622,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *232 + - *235 requestBody: required: true content: @@ -37955,9 +38647,9 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: - default: *234 + default: *237 '304': *35 '403': *27 '401': *23 @@ -37976,7 +38668,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *232 + - *235 responses: '204': description: Response @@ -37999,7 +38691,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *232 + - *235 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -38020,7 +38712,7 @@ paths: application/json: schema: type: array - items: *230 + items: *233 examples: default: value: @@ -38073,7 +38765,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *232 + - *235 requestBody: required: true content: @@ -38117,9 +38809,9 @@ paths: description: Response content: application/json: - schema: *230 + schema: *233 examples: - default: *231 + default: *234 '304': *35 '403': *27 '401': *23 @@ -38129,8 +38821,8 @@ paths: application/json: schema: oneOf: - - *89 - - *90 + - *92 + - *93 '503': description: Response content: @@ -38169,7 +38861,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *232 + - *235 requestBody: required: true content: @@ -38226,15 +38918,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *226 + - *229 responses: '200': description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: &235 + default: &238 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -38287,7 +38979,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *226 + - *229 requestBody: required: false content: @@ -38336,9 +39028,9 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *235 + default: *238 '404': description: Not Found if the authenticated user does not have access to the project @@ -38359,7 +39051,7 @@ paths: items: type: string '401': *23 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -38377,7 +39069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *226 + - *229 responses: '204': description: Delete Success @@ -38398,7 +39090,7 @@ paths: items: type: string '401': *23 - '410': *236 + '410': *239 '404': *6 x-github: githubCloudOnly: false @@ -38421,7 +39113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *226 + - *229 - 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 @@ -38448,7 +39140,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -38473,8 +39165,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *226 - - *118 + - *229 + - *121 requestBody: required: false content: @@ -38523,8 +39215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *226 - - *118 + - *229 + - *121 responses: '204': description: Response @@ -38552,8 +39244,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *226 - - *118 + - *229 + - *121 responses: '200': description: Response @@ -38617,7 +39309,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *226 + - *229 - *17 - *18 responses: @@ -38627,7 +39319,7 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: default: value: @@ -38659,7 +39351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *226 + - *229 requestBody: required: true content: @@ -38683,7 +39375,7 @@ paths: description: Response content: application/json: - schema: *233 + schema: *236 examples: default: value: @@ -38744,7 +39436,7 @@ paths: resources: type: object properties: - core: &237 + core: &240 title: Rate Limit type: object properties: @@ -38761,19 +39453,19 @@ paths: - remaining - reset - used - graphql: *237 - search: *237 - code_search: *237 - source_import: *237 - integration_manifest: *237 - code_scanning_upload: *237 - actions_runner_registration: *237 - scim: *237 - dependency_snapshots: *237 + graphql: *240 + search: *240 + code_search: *240 + source_import: *240 + integration_manifest: *240 + code_scanning_upload: *240 + actions_runner_registration: *240 + scim: *240 + dependency_snapshots: *240 required: - core - search - rate: *237 + rate: *240 required: - rate - resources @@ -38872,14 +39564,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *238 + schema: *241 examples: default-response: summary: Default response @@ -39380,7 +40072,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *239 + '301': *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39398,8 +40090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -39636,10 +40328,10 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 - '307': &241 + default: *243 + '307': &244 description: Temporary Redirect content: application/json: @@ -39668,8 +40360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -39691,7 +40383,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *241 + '307': *244 '404': *6 x-github: githubCloudOnly: false @@ -39714,11 +40406,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - - &267 + - &270 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -39741,7 +40433,7 @@ paths: type: integer artifacts: type: array - items: &242 + items: &245 title: Artifact description: An artifact type: object @@ -39827,7 +40519,7 @@ paths: - expires_at - updated_at examples: - default: &268 + default: &271 value: total_count: 2 artifacts: @@ -39886,9 +40578,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *227 - - *228 - - &243 + - *230 + - *231 + - &246 name: artifact_id description: The unique identifier of the artifact. in: path @@ -39900,7 +40592,7 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: default: value: @@ -39937,9 +40629,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *227 - - *228 - - *243 + - *230 + - *231 + - *246 responses: '204': description: Response @@ -39963,9 +40655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *227 - - *228 - - *243 + - *230 + - *231 + - *246 - name: archive_format in: path required: true @@ -39979,7 +40671,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40002,14 +40694,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *244 + schema: *247 examples: default: value: @@ -40035,11 +40727,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - - &245 + - &248 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 @@ -40073,7 +40765,7 @@ paths: description: Response content: application/json: - schema: &246 + schema: &249 title: Repository actions caches description: Repository actions caches type: object @@ -40123,7 +40815,7 @@ paths: - total_count - actions_caches examples: - default: &247 + default: &250 value: total_count: 1 actions_caches: @@ -40155,23 +40847,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-github-actions-caches-for-a-repository-using-a-cache-key parameters: - - *227 - - *228 + - *230 + - *231 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *245 + - *248 responses: '200': description: Response content: application/json: - schema: *246 + schema: *249 examples: - default: *247 + default: *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40191,8 +40883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id parameters: - - *227 - - *228 + - *230 + - *231 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -40223,9 +40915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *227 - - *228 - - &248 + - *230 + - *231 + - &251 name: job_id description: The unique identifier of the job. in: path @@ -40237,7 +40929,7 @@ paths: description: Response content: application/json: - schema: &271 + schema: &274 title: Job description: Information of a job execution in a workflow run type: object @@ -40584,9 +41276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *227 - - *228 - - *248 + - *230 + - *231 + - *251 responses: '302': description: Response @@ -40614,9 +41306,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *227 - - *228 - - *248 + - *230 + - *231 + - *251 requestBody: required: false content: @@ -40638,7 +41330,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -40662,8 +41354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Status response @@ -40713,8 +41405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -40748,7 +41440,7 @@ paths: description: Empty response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -40777,8 +41469,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -40796,7 +41488,7 @@ paths: type: integer secrets: type: array - items: &273 + items: &276 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -40817,7 +41509,7 @@ paths: - created_at - updated_at examples: - default: &274 + default: &277 value: total_count: 2 secrets: @@ -40850,9 +41542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *227 - - *228 - - *249 + - *230 + - *231 + - *252 - *18 responses: '200': @@ -40869,7 +41561,7 @@ paths: type: integer variables: type: array - items: &277 + items: &280 title: Actions Variable type: object properties: @@ -40903,7 +41595,7 @@ paths: - created_at - updated_at examples: - default: &278 + default: &281 value: total_count: 2 variables: @@ -40936,8 +41628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -40946,11 +41638,11 @@ paths: schema: type: object properties: - enabled: &251 + enabled: &254 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *95 - selected_actions_url: *250 + allowed_actions: *98 + selected_actions_url: *253 required: - enabled examples: @@ -40977,8 +41669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -40989,8 +41681,8 @@ paths: schema: type: object properties: - enabled: *251 - allowed_actions: *95 + enabled: *254 + allowed_actions: *98 required: - enabled examples: @@ -41019,14 +41711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &252 + schema: &255 type: object properties: access_level: @@ -41043,7 +41735,7 @@ paths: required: - access_level examples: - default: &253 + default: &256 value: access_level: organization x-github: @@ -41067,15 +41759,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-the-level-of-access-for-workflows-outside-of-the-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: application/json: - schema: *252 + schema: *255 examples: - default: *253 + default: *256 responses: '204': description: Response @@ -41099,16 +41791,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41127,8 +41819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -41136,9 +41828,9 @@ paths: required: false content: application/json: - schema: *97 + schema: *100 examples: - selected_actions: *98 + selected_actions: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -41160,16 +41852,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *254 + schema: *257 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41190,8 +41882,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Success response @@ -41202,9 +41894,9 @@ paths: required: true content: application/json: - schema: *255 + schema: *258 examples: - default: *101 + default: *104 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41231,8 +41923,8 @@ paths: in: query schema: type: string - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -41250,9 +41942,9 @@ paths: type: integer runners: type: array - items: *107 + items: *110 examples: - default: *108 + default: *111 headers: Link: *37 x-github: @@ -41276,8 +41968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -41285,9 +41977,9 @@ paths: application/json: schema: type: array - items: *256 + items: *259 examples: - default: *257 + default: *260 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41309,8 +42001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -41353,7 +42045,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *258 + '201': *261 '404': *6 '422': *7 x-github: @@ -41383,16 +42075,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *259 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41420,16 +42112,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41451,17 +42143,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: '200': description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: *261 + default: *264 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41482,9 +42174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: '204': description: Response @@ -41509,11 +42201,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: - '200': *111 + '200': *114 '404': *6 x-github: githubCloudOnly: false @@ -41535,9 +42227,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 requestBody: required: true content: @@ -41561,7 +42253,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41585,9 +42277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 requestBody: required: true content: @@ -41612,7 +42304,7 @@ paths: - gpu - accelerated responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41636,11 +42328,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 + - *230 + - *231 + - *109 responses: - '200': *262 + '200': *265 '404': *6 x-github: githubCloudOnly: false @@ -41667,12 +42359,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository parameters: - - *227 - - *228 - - *106 - - *263 + - *230 + - *231 + - *109 + - *266 responses: - '200': *111 + '200': *114 '404': *6 '422': *7 x-github: @@ -41698,9 +42390,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *227 - - *228 - - &281 + - *230 + - *231 + - &284 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. @@ -41708,7 +42400,7 @@ paths: required: false schema: type: string - - &282 + - &285 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -41716,7 +42408,7 @@ paths: required: false schema: type: string - - &283 + - &286 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -41725,7 +42417,7 @@ paths: required: false schema: type: string - - &284 + - &287 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 @@ -41752,7 +42444,7 @@ paths: - pending - *17 - *18 - - &285 + - &288 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)." @@ -41761,7 +42453,7 @@ paths: schema: type: string format: date-time - - &264 + - &267 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -41770,13 +42462,13 @@ paths: schema: type: boolean default: false - - &286 + - &289 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &287 + - &290 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -41799,7 +42491,7 @@ paths: type: integer workflow_runs: type: array - items: &265 + items: &268 title: Workflow Run description: An invocation of a workflow type: object @@ -41916,7 +42608,7 @@ paths: type: - array - 'null' - items: &306 + items: &309 title: Pull Request Minimal type: object properties: @@ -42043,7 +42735,7 @@ paths: head_commit: anyOf: - type: 'null' - - &310 + - &313 title: Simple Commit description: A commit. type: object @@ -42117,8 +42809,8 @@ paths: - timestamp - author - committer - repository: *105 - head_repository: *105 + repository: *108 + head_repository: *108 head_repository_id: type: integer examples: @@ -42158,7 +42850,7 @@ paths: - workflow_url - pull_requests examples: - default: &288 + default: &291 value: total_count: 1 workflow_runs: @@ -42394,24 +43086,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *227 - - *228 - - &266 + - *230 + - *231 + - &269 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *264 + - *267 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: &269 + default: &272 value: id: 30433642 name: Build @@ -42652,9 +43344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '204': description: Response @@ -42677,9 +43369,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -42807,15 +43499,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#approve-a-workflow-run-for-a-fork-pull-request parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -42842,12 +43534,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 - *17 - *18 - - *267 + - *270 responses: '200': description: Response @@ -42863,9 +43555,9 @@ paths: type: integer artifacts: type: array - items: *242 + items: *245 examples: - default: *268 + default: *271 headers: Link: *37 x-github: @@ -42889,25 +43581,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *227 - - *228 - - *266 - - &270 + - *230 + - *231 + - *269 + - &273 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *264 + - *267 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *269 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42930,10 +43622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *227 - - *228 - - *266 - - *270 + - *230 + - *231 + - *269 + - *273 - *17 - *18 responses: @@ -42951,9 +43643,9 @@ paths: type: integer jobs: type: array - items: *271 + items: *274 examples: - default: &272 + default: &275 value: total_count: 1 jobs: @@ -43066,10 +43758,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *227 - - *228 - - *266 - - *270 + - *230 + - *231 + - *269 + - *273 responses: '302': description: Response @@ -43097,19 +43789,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '202': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43132,9 +43824,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: true content: @@ -43201,19 +43893,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '202': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43236,9 +43928,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 - 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 @@ -43268,9 +43960,9 @@ paths: type: integer jobs: type: array - items: *271 + items: *274 examples: - default: *272 + default: *275 headers: Link: *37 x-github: @@ -43295,9 +43987,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '302': description: Response @@ -43324,9 +44016,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '204': description: Response @@ -43353,9 +44045,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -43424,7 +44116,7 @@ paths: items: type: object properties: - type: &381 + type: &384 type: string description: The type of reviewer. enum: @@ -43435,7 +44127,7 @@ paths: reviewer: anyOf: - *4 - - *158 + - *161 required: - environment - wait_timer @@ -43510,9 +44202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: true content: @@ -43562,7 +44254,7 @@ paths: application/json: schema: type: array - items: &376 + items: &379 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -43674,7 +44366,7 @@ paths: - created_at - updated_at examples: - default: &377 + default: &380 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -43730,9 +44422,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: false content: @@ -43754,7 +44446,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -43777,9 +44469,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 requestBody: required: false content: @@ -43801,7 +44493,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -43826,9 +44518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *227 - - *228 - - *266 + - *230 + - *231 + - *269 responses: '200': description: Response @@ -43965,8 +44657,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -43984,9 +44676,9 @@ paths: type: integer secrets: type: array - items: *273 + items: *276 examples: - default: *274 + default: *277 headers: Link: *37 x-github: @@ -44011,16 +44703,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44042,17 +44734,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: &394 + default: &397 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -44078,9 +44770,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -44108,7 +44800,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -44134,9 +44826,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -44161,9 +44853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *227 - - *228 - - *249 + - *230 + - *231 + - *252 - *18 responses: '200': @@ -44180,9 +44872,9 @@ paths: type: integer variables: type: array - items: *277 + items: *280 examples: - default: *278 + default: *281 headers: Link: *37 x-github: @@ -44205,8 +44897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -44233,7 +44925,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -44258,17 +44950,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: &395 + default: &398 value: name: USERNAME value: octocat @@ -44294,9 +44986,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 requestBody: required: true content: @@ -44338,9 +45030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *227 - - *228 - - *116 + - *230 + - *231 + - *119 responses: '204': description: Response @@ -44365,8 +45057,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -44384,7 +45076,7 @@ paths: type: integer workflows: type: array - items: &279 + items: &282 title: Workflow description: A GitHub Actions workflow type: object @@ -44502,9 +45194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *227 - - *228 - - &280 + - *230 + - *231 + - &283 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -44519,7 +45211,7 @@ paths: description: Response content: application/json: - schema: *279 + schema: *282 examples: default: value: @@ -44552,9 +45244,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44579,9 +45271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44632,9 +45324,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '204': description: Response @@ -44659,19 +45351,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *227 - - *228 - - *280 - - *281 - - *282 + - *230 + - *231 - *283 - *284 - - *17 - - *18 - *285 - - *264 - *286 - *287 + - *17 + - *18 + - *288 + - *267 + - *289 + - *290 responses: '200': description: Response @@ -44687,9 +45379,9 @@ paths: type: integer workflow_runs: type: array - items: *265 + items: *268 examples: - default: *288 + default: *291 headers: Link: *37 x-github: @@ -44715,9 +45407,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *227 - - *228 - - *280 + - *230 + - *231 + - *283 responses: '200': description: Response @@ -44778,8 +45470,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *227 - - *228 + - *230 + - *231 - *40 - *17 - *41 @@ -44947,8 +45639,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -44960,7 +45652,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -44985,8 +45677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *227 - - *228 + - *230 + - *231 - name: assignee in: path required: true @@ -45022,8 +45714,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -45135,8 +45827,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *41 - *42 @@ -45180,7 +45872,7 @@ paths: repository_id: type: integer examples: - default: *289 + default: *292 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45200,8 +45892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -45209,7 +45901,7 @@ paths: application/json: schema: type: array - items: &290 + items: &293 title: Autolink reference description: An autolink reference. type: object @@ -45263,8 +45955,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -45303,9 +45995,9 @@ paths: description: response content: application/json: - schema: *290 + schema: *293 examples: - default: &291 + default: &294 value: id: 1 key_prefix: TICKET- @@ -45336,9 +46028,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *227 - - *228 - - &292 + - *230 + - *231 + - &295 name: autolink_id description: The unique identifier of the autolink. in: path @@ -45350,9 +46042,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: *291 + default: *294 '404': *6 x-github: githubCloudOnly: false @@ -45372,9 +46064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *227 - - *228 - - *292 + - *230 + - *231 + - *295 responses: '204': description: Response @@ -45398,8 +46090,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response if Dependabot is enabled @@ -45449,8 +46141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -45471,8 +46163,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -45492,8 +46184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *227 - - *228 + - *230 + - *231 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -45531,7 +46223,7 @@ paths: - url protected: type: boolean - protection: &294 + protection: &297 title: Branch Protection description: Branch Protection type: object @@ -45574,7 +46266,7 @@ paths: required: - contexts - checks - enforce_admins: &297 + enforce_admins: &300 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -45591,7 +46283,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &299 + required_pull_request_reviews: &302 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -45613,7 +46305,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *158 + items: *161 apps: description: The list of apps with review dismissal access. @@ -45645,7 +46337,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *158 + items: *161 apps: description: The list of apps allowed to bypass pull request requirements. @@ -45675,7 +46367,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &296 + restrictions: &299 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -46000,9 +46692,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *227 - - *228 - - &295 + - *230 + - *231 + - &298 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). @@ -46016,14 +46708,14 @@ paths: description: Response content: application/json: - schema: &305 + schema: &308 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &352 + commit: &355 title: Commit description: Commit type: object @@ -46062,7 +46754,7 @@ paths: author: anyOf: - type: 'null' - - &293 + - &296 title: Git User description: Metaproperties for Git author/committer information. @@ -46083,7 +46775,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 message: type: string examples: @@ -46107,7 +46799,7 @@ paths: required: - sha - url - verification: &401 + verification: &404 title: Verification type: object properties: @@ -46138,14 +46830,14 @@ paths: author: oneOf: - *4 - - *114 + - *117 type: - 'null' - object committer: oneOf: - *4 - - *114 + - *117 type: - 'null' - object @@ -46182,7 +46874,7 @@ paths: type: integer files: type: array - items: &364 + items: &367 title: Diff Entry description: Diff Entry type: object @@ -46276,7 +46968,7 @@ paths: - self protected: type: boolean - protection: *294 + protection: *297 protection_url: type: string format: uri @@ -46384,7 +47076,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *239 + '301': *242 '404': *6 x-github: githubCloudOnly: false @@ -46406,15 +47098,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -46608,9 +47300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -46870,7 +47562,7 @@ paths: url: type: string format: uri - required_status_checks: &302 + required_status_checks: &305 title: Status Check Policy description: Status Check Policy type: object @@ -46951,7 +47643,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 apps: type: array items: *5 @@ -46969,7 +47661,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 apps: type: array items: *5 @@ -47029,7 +47721,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *296 + restrictions: *299 required_conversation_resolution: type: object properties: @@ -47141,9 +47833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47168,17 +47860,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: &298 + default: &301 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -47200,17 +47892,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47229,9 +47921,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47256,17 +47948,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *299 + schema: *302 examples: - default: &300 + default: &303 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -47362,9 +48054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47462,9 +48154,9 @@ paths: description: Response content: application/json: - schema: *299 + schema: *302 examples: - default: *300 + default: *303 '422': *15 x-github: githubCloudOnly: false @@ -47485,9 +48177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47514,17 +48206,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: &301 + default: &304 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -47547,17 +48239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *301 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -47577,9 +48269,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47604,17 +48296,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: &303 + default: &306 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -47640,9 +48332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47694,9 +48386,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: *303 + default: *306 '404': *6 '422': *15 x-github: @@ -47718,9 +48410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -47744,9 +48436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -47780,9 +48472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47849,9 +48541,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -47915,9 +48607,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: content: application/json: @@ -47983,15 +48675,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response content: application/json: - schema: *296 + schema: *299 examples: default: value: @@ -48082,9 +48774,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '204': description: Response @@ -48107,9 +48799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48119,7 +48811,7 @@ paths: type: array items: *5 examples: - default: &304 + default: &307 value: - id: 1 slug: octoapp @@ -48176,9 +48868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48212,7 +48904,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48233,9 +48925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48269,7 +48961,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48290,9 +48982,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48326,7 +49018,7 @@ paths: type: array items: *5 examples: - default: *304 + default: *307 '422': *15 x-github: githubCloudOnly: false @@ -48348,9 +49040,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48358,9 +49050,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '404': *6 x-github: githubCloudOnly: false @@ -48380,9 +49072,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -48418,9 +49110,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48441,9 +49133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: false content: @@ -48479,9 +49171,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48502,9 +49194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: content: application/json: @@ -48539,9 +49231,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 '422': *15 x-github: githubCloudOnly: false @@ -48563,9 +49255,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 responses: '200': description: Response @@ -48575,7 +49267,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '404': *6 x-github: githubCloudOnly: false @@ -48599,9 +49291,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48634,7 +49326,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48659,9 +49351,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48694,7 +49386,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48719,9 +49411,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48754,7 +49446,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '422': *15 x-github: githubCloudOnly: false @@ -48781,9 +49473,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 requestBody: required: true content: @@ -48805,7 +49497,7 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: default: value: @@ -48920,8 +49612,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -49200,7 +49892,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &310 title: CheckRun description: A check performed on the code of a given code change type: object @@ -49335,8 +50027,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *306 - deployment: &583 + items: *309 + deployment: &586 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -49623,9 +50315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *227 - - *228 - - &308 + - *230 + - *231 + - &311 name: check_run_id description: The unique identifier of the check run. in: path @@ -49637,9 +50329,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *310 examples: - default: &309 + default: &312 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -49739,9 +50431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 requestBody: required: true content: @@ -49981,9 +50673,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *310 examples: - default: *309 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50003,9 +50695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 - *17 - *18 responses: @@ -50117,15 +50809,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *227 - - *228 - - *308 + - *230 + - *231 + - *311 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -50163,8 +50855,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -50186,7 +50878,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &311 + schema: &314 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -50267,12 +50959,12 @@ paths: type: - array - 'null' - items: *306 + items: *309 app: anyOf: - type: 'null' - *5 - repository: *105 + repository: *108 created_at: type: - string @@ -50283,7 +50975,7 @@ paths: - string - 'null' format: date-time - head_commit: *310 + head_commit: *313 latest_check_runs_count: type: integer check_runs_url: @@ -50311,7 +51003,7 @@ paths: - check_runs_url - pull_requests examples: - default: &312 + default: &315 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -50602,9 +51294,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50623,8 +51315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -50685,7 +51377,7 @@ paths: required: - app_id - setting - repository: *105 + repository: *108 examples: default: value: @@ -50933,9 +51625,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *227 - - *228 - - &313 + - *230 + - *231 + - &316 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -50947,9 +51639,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50972,17 +51664,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *227 - - *228 - - *313 - - &359 + - *230 + - *231 + - *316 + - &362 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &360 + - &363 name: status description: Returns check runs with the specified `status`. in: query @@ -51021,9 +51713,9 @@ paths: type: integer check_runs: type: array - items: *307 + items: *310 examples: - default: &361 + default: &364 value: total_count: 1 check_runs: @@ -51125,15 +51817,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *227 - - *228 - - *313 + - *230 + - *231 + - *316 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -51160,21 +51852,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *227 - - *228 - - *314 - - *315 + - *230 + - *231 + - *317 + - *318 - *18 - *17 - - &328 + - &331 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: *316 - - &329 + schema: *319 + - &332 name: pr description: The number of the pull request for the results you want to list. in: query @@ -51199,13 +51891,13 @@ paths: be returned. in: query required: false - schema: *317 + schema: *320 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *318 + schema: *321 responses: '200': description: Response @@ -51221,19 +51913,19 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: *319 - state: *123 - fixed_at: *119 + instances_url: *322 + state: *126 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: *320 - dismissed_comment: *321 - rule: *322 - tool: *323 - most_recent_instance: *324 + dismissed_at: *123 + dismissed_reason: *323 + dismissed_comment: *324 + rule: *325 + tool: *326 + most_recent_instance: *327 required: - number - created_at @@ -51349,14 +52041,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &325 + '403': &328 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51376,9 +52068,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *227 - - *228 - - &326 + - *230 + - *231 + - &329 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -51392,7 +52084,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &330 type: object properties: number: *46 @@ -51400,16 +52092,16 @@ paths: updated_at: *48 url: *49 html_url: *50 - instances_url: *319 - state: *123 - fixed_at: *119 + instances_url: *322 + state: *126 + fixed_at: *122 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *120 - dismissed_reason: *320 - dismissed_comment: *321 + dismissed_at: *123 + dismissed_reason: *323 + dismissed_comment: *324 rule: type: object properties: @@ -51471,8 +52163,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *323 - most_recent_instance: *324 + tool: *326 + most_recent_instance: *327 required: - number - created_at @@ -51561,9 +52253,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51581,9 +52273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 requestBody: required: true content: @@ -51598,8 +52290,8 @@ paths: enum: - open - dismissed - dismissed_reason: *320 - dismissed_comment: *321 + dismissed_reason: *323 + dismissed_comment: *324 required: - state examples: @@ -51614,7 +52306,7 @@ paths: description: Response content: application/json: - schema: *327 + schema: *330 examples: default: value: @@ -51689,14 +52381,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &334 + '403': &337 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51716,13 +52408,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 - *18 - *17 - - *328 - - *329 + - *331 + - *332 responses: '200': description: Response @@ -51730,7 +52422,7 @@ paths: application/json: schema: type: array - items: *324 + items: *327 examples: default: value: @@ -51769,9 +52461,9 @@ paths: end_column: 50 classifications: - source - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51803,25 +52495,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *227 - - *228 - - *314 - - *315 + - *230 + - *231 + - *317 + - *318 - *18 - *17 - - *329 + - *332 - 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: *316 + schema: *319 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &332 + schema: &335 type: string description: An identifier for the upload. examples: @@ -51843,23 +52535,23 @@ paths: application/json: schema: type: array - items: &333 + items: &336 type: object properties: - ref: *316 - commit_sha: &342 + ref: *319 + commit_sha: &345 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: *330 + analysis_key: *333 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *331 + category: *334 error: type: string examples: @@ -51884,8 +52576,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *332 - tool: *323 + sarif_id: *335 + tool: *326 deletable: type: boolean warning: @@ -51947,9 +52639,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51983,8 +52675,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -51997,7 +52689,7 @@ paths: description: Response content: application/json: - schema: *333 + schema: *336 examples: response: summary: application/json response @@ -52051,9 +52743,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52133,8 +52825,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -52190,9 +52882,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *334 + '403': *337 '404': *6 - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52212,8 +52904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -52221,7 +52913,7 @@ paths: application/json: schema: type: array - items: &335 + items: &338 title: CodeQL Database description: A CodeQL database. type: object @@ -52333,9 +53025,9 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52362,8 +53054,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: language in: path description: The language of the CodeQL database. @@ -52375,7 +53067,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *338 examples: default: value: @@ -52407,11 +53099,11 @@ paths: updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - '302': &366 + '302': &369 description: Found - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52437,8 +53129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -52447,7 +53139,7 @@ paths: type: object additionalProperties: false properties: - language: &336 + language: &339 type: string description: The language targeted by the CodeQL query enum: @@ -52525,7 +53217,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &340 + schema: &343 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -52535,7 +53227,7 @@ paths: description: The ID of the variant analysis. controller_repo: *51 actor: *4 - query_language: *336 + query_language: *339 query_pack_url: type: string description: The download url for the query pack. @@ -52583,7 +53275,7 @@ paths: items: type: object properties: - repository: &337 + repository: &340 title: Repository Identifier description: Repository Identifier type: object @@ -52625,7 +53317,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &341 + analysis_status: &344 type: string description: The new status of the CodeQL variant analysis repository task. @@ -52657,7 +53349,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &338 + access_mismatch_repos: &341 type: object properties: repository_count: @@ -52672,7 +53364,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: *337 + items: *340 required: - repository_count - repositories @@ -52695,8 +53387,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *338 - over_limit_repos: *338 + no_codeql_db_repos: *341 + over_limit_repos: *341 required: - access_mismatch_repos - not_found_repos @@ -52712,7 +53404,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &339 + value: &342 summary: Default response value: id: 1 @@ -52864,17 +53556,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *339 + value: *342 repository_lists: summary: Response for a successful variant analysis submission - value: *339 + value: *342 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52895,8 +53587,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis parameters: - - *227 - - *228 + - *230 + - *231 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -52908,11 +53600,11 @@ paths: description: Response content: application/json: - schema: *340 + schema: *343 examples: - default: *339 + default: *342 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52933,7 +53625,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis parameters: - - *227 + - *230 - name: repo in: path description: The name of the controller repository. @@ -52968,7 +53660,7 @@ paths: type: object properties: repository: *51 - analysis_status: *341 + analysis_status: *344 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -53072,7 +53764,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53093,8 +53785,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53159,9 +53851,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *325 + '403': *328 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53180,8 +53872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -53226,7 +53918,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -53251,7 +53943,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *334 + '403': *337 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -53259,7 +53951,7 @@ paths: content: application/json: schema: *3 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53316,8 +54008,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -53325,7 +54017,7 @@ paths: schema: type: object properties: - commit_sha: *342 + commit_sha: *345 ref: type: string description: |- @@ -53385,7 +54077,7 @@ paths: schema: type: object properties: - id: *332 + id: *335 url: type: string description: The REST API URL for checking the status of the upload. @@ -53399,11 +54091,11 @@ paths: url: https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6 '400': description: Bad Request if the sarif field is invalid - '403': *334 + '403': *337 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53422,8 +54114,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *227 - - *228 + - *230 + - *231 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -53471,10 +54163,10 @@ paths: value: processing_status: complete analyses_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6 - '403': *325 + '403': *328 '404': description: Not Found if the sarif id does not match any upload - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53496,8 +54188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53521,7 +54213,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *124 + configuration: *127 examples: default: value: @@ -53550,7 +54242,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': *128 + '204': *131 '304': *35 '403': *27 '404': *6 @@ -53575,8 +54267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -53704,8 +54396,8 @@ paths: parameters: - *17 - *18 - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -53721,7 +54413,7 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: default: value: @@ -54019,8 +54711,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -54084,22 +54776,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54123,8 +54815,8 @@ paths: parameters: - *17 - *18 - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -54188,8 +54880,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -54226,9 +54918,9 @@ paths: type: integer machines: type: array - items: *344 + items: *347 examples: - default: &541 + default: &544 value: total_count: 2 machines: @@ -54268,8 +54960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *227 - - *228 + - *230 + - *231 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -54356,8 +55048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -54405,7 +55097,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54426,8 +55118,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -54445,7 +55137,7 @@ paths: type: integer secrets: type: array - items: &348 + items: &351 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -54466,7 +55158,7 @@ paths: - created_at - updated_at examples: - default: *345 + default: *348 headers: Link: *37 x-github: @@ -54489,16 +55181,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -54518,17 +55210,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *348 + schema: *351 examples: - default: *349 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54548,9 +55240,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -54578,7 +55270,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -54602,9 +55294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -54632,8 +55324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *227 - - *228 + - *230 + - *231 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -54671,7 +55363,7 @@ paths: application/json: schema: type: array - items: &350 + items: &353 title: Collaborator description: Collaborator type: object @@ -54864,9 +55556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '204': description: Response if user is a collaborator @@ -54908,9 +55600,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 requestBody: required: false content: @@ -54936,7 +55628,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &414 + schema: &417 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -54948,7 +55640,7 @@ paths: format: int64 examples: - 42 - repository: *105 + repository: *108 invitee: anyOf: - type: 'null' @@ -55157,9 +55849,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '204': description: No Content when collaborator was removed from the repository. @@ -55188,9 +55880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *227 - - *228 - - *118 + - *230 + - *231 + - *121 responses: '200': description: if user has admin permissions @@ -55210,7 +55902,7 @@ paths: user: anyOf: - type: 'null' - - *350 + - *353 required: - permission - role_name @@ -55264,8 +55956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -55275,7 +55967,7 @@ paths: application/json: schema: type: array - items: &351 + items: &354 title: Commit Comment description: Commit Comment type: object @@ -55316,8 +56008,8 @@ paths: updated_at: type: string format: date-time - author_association: *55 - reactions: *56 + author_association: *58 + reactions: *59 required: - url - html_url @@ -55333,7 +56025,7 @@ paths: - created_at - updated_at examples: - default: &354 + default: &357 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55392,17 +56084,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: &355 + default: &358 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -55459,9 +56151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -55483,7 +56175,7 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: default: value: @@ -55534,9 +56226,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -55557,9 +56249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. @@ -55585,9 +56277,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -55608,9 +56300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -55642,16 +56334,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -55673,10 +56365,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -55724,8 +56416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *227 - - *228 + - *230 + - *231 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -55781,9 +56473,9 @@ paths: application/json: schema: type: array - items: *352 + items: *355 examples: - default: &461 + default: &464 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55856,7 +56548,7 @@ paths: '500': *39 '400': *14 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55876,9 +56568,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *227 - - *228 - - &353 + - *230 + - *231 + - &356 name: commit_sha description: The SHA of the commit. in: path @@ -55925,7 +56617,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55950,9 +56642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 - *17 - *18 responses: @@ -55962,9 +56654,9 @@ paths: application/json: schema: type: array - items: *351 + items: *354 examples: - default: *354 + default: *357 headers: Link: *37 x-github: @@ -55992,9 +56684,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 requestBody: required: true content: @@ -56029,9 +56721,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: *355 + default: *358 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56059,9 +56751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 - *17 - *18 responses: @@ -56071,7 +56763,7 @@ paths: application/json: schema: type: array - items: &452 + items: &455 title: Pull Request Simple description: Pull Request Simple type: object @@ -56191,7 +56883,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 active_lock_reason: type: - string @@ -56246,7 +56938,7 @@ paths: type: - array - 'null' - items: *158 + items: *161 head: type: object properties: @@ -56254,7 +56946,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: @@ -56274,7 +56966,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: @@ -56290,7 +56982,7 @@ paths: _links: type: object properties: - comments: &357 + comments: &360 title: Link description: Hypermedia Link type: object @@ -56299,13 +56991,13 @@ paths: type: string required: - href - commits: *357 - statuses: *357 - html: *357 - issue: *357 - review_comments: *357 - review_comment: *357 - self: *357 + commits: *360 + statuses: *360 + html: *360 + issue: *360 + review_comments: *360 + review_comment: *360 + self: *360 required: - comments - commits @@ -56315,8 +57007,8 @@ paths: - review_comments - review_comment - self - author_association: *55 - auto_merge: &454 + author_association: *58 + auto_merge: &457 title: Auto merge description: The status of auto merging a pull request. type: @@ -56381,7 +57073,7 @@ paths: - author_association - auto_merge examples: - default: &453 + default: &456 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -56861,7 +57553,7 @@ paths: draft: false headers: Link: *37 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56917,11 +57609,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 - - &358 + - &361 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)" @@ -56936,9 +57628,9 @@ paths: description: Response content: application/json: - schema: *352 + schema: *355 examples: - default: &440 + default: &443 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57024,8 +57716,8 @@ paths: '422': *15 '404': *6 '500': *39 - '503': *57 - '409': *125 + '503': *60 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57050,11 +57742,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *227 - - *228 - - *358 - - *359 - - *360 + - *230 + - *231 + - *361 + - *362 + - *363 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -57088,9 +57780,9 @@ paths: type: integer check_runs: type: array - items: *307 + items: *310 examples: - default: *361 + default: *364 headers: Link: *37 x-github: @@ -57115,9 +57807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -57125,7 +57817,7 @@ paths: schema: type: integer example: 1 - - *359 + - *362 - *17 - *18 responses: @@ -57143,7 +57835,7 @@ paths: type: integer check_suites: type: array - items: *311 + items: *314 examples: default: value: @@ -57343,9 +58035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - *17 - *18 responses: @@ -57416,7 +58108,7 @@ paths: type: string total_count: type: integer - repository: *105 + repository: *108 commit_url: type: string format: uri @@ -57547,9 +58239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *227 - - *228 - - *358 + - *230 + - *231 + - *361 - *17 - *18 responses: @@ -57559,7 +58251,7 @@ paths: application/json: schema: type: array - items: &515 + items: &518 title: Status description: The status of a commit. type: object @@ -57640,7 +58332,7 @@ paths: site_admin: false headers: Link: *37 - '301': *239 + '301': *242 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57668,8 +58360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -57702,11 +58394,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *362 + - *365 code_of_conduct_file: anyOf: - type: 'null' - - &363 + - &366 title: Community Health File type: object properties: @@ -57722,23 +58414,23 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 contributing: anyOf: - type: 'null' - - *363 + - *366 readme: anyOf: - type: 'null' - - *363 + - *366 issue_template: anyOf: - type: 'null' - - *363 + - *366 pull_request_template: anyOf: - type: 'null' - - *363 + - *366 required: - code_of_conduct - code_of_conduct_file @@ -57866,8 +58558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 - name: basehead @@ -57915,8 +58607,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *352 - merge_base_commit: *352 + base_commit: *355 + merge_base_commit: *355 status: type: string enum: @@ -57940,10 +58632,10 @@ paths: - 6 commits: type: array - items: *352 + items: *355 files: type: array - items: *364 + items: *367 required: - url - html_url @@ -58184,7 +58876,7 @@ paths: module Test" '404': *6 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58226,8 +58918,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -58378,7 +59070,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &365 + response-if-content-is-a-file: &368 summary: Response if content is a file value: type: file @@ -58515,7 +59207,7 @@ paths: - size - type - url - - &466 + - &469 title: Content File description: Content File type: object @@ -58733,7 +59425,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *365 + response-if-content-is-a-file: *368 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -58802,7 +59494,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *366 + '302': *369 '304': *35 x-github: githubCloudOnly: false @@ -58825,8 +59517,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -58921,7 +59613,7 @@ paths: description: Response content: application/json: - schema: &367 + schema: &370 title: File Commit description: File Commit type: object @@ -59072,7 +59764,7 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: example-for-creating-a-file: value: @@ -59125,7 +59817,7 @@ paths: schema: oneOf: - *3 - - &396 + - &399 description: Repository rule violation was detected type: object properties: @@ -59146,7 +59838,7 @@ paths: items: type: object properties: - placeholder_id: &508 + placeholder_id: &511 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -59178,8 +59870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *227 - - *228 + - *230 + - *231 - name: path description: path parameter in: path @@ -59240,7 +59932,7 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: default: value: @@ -59273,8 +59965,8 @@ paths: payload: '422': *15 '404': *6 - '409': *125 - '503': *57 + '409': *128 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59294,8 +59986,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *227 - - *228 + - *230 + - *231 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -59419,20 +60111,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *227 - - *228 - - *133 - - *134 - - *135 + - *230 + - *231 - *136 + - *137 + - *138 + - *139 - 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 - - *137 - - *138 + - *140 + - *141 - *40 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -59452,8 +60144,8 @@ paths: default: 30 - *41 - *42 - - *139 - - *140 + - *142 + - *143 responses: '200': description: Response @@ -59461,7 +60153,7 @@ paths: application/json: schema: type: array - items: &370 + items: &373 type: object description: A Dependabot alert. properties: @@ -59496,13 +60188,13 @@ paths: - development - runtime - - security_advisory: *368 + security_advisory: *371 security_vulnerability: *45 url: *49 html_url: *50 created_at: *47 updated_at: *48 - dismissed_at: *120 + dismissed_at: *123 dismissed_by: anyOf: - type: 'null' @@ -59526,8 +60218,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *119 - auto_dismissed_at: *369 + fixed_at: *122 + auto_dismissed_at: *372 required: - number - state @@ -59754,9 +60446,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *227 - - *228 - - &371 + - *230 + - *231 + - &374 name: alert_number in: path description: |- @@ -59771,7 +60463,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *373 examples: default: value: @@ -59881,9 +60573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *227 - - *228 - - *371 + - *230 + - *231 + - *374 requestBody: required: true content: @@ -59928,7 +60620,7 @@ paths: description: Response content: application/json: - schema: *370 + schema: *373 examples: default: value: @@ -60034,7 +60726,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *125 + '409': *128 '422': *7 x-github: githubCloudOnly: false @@ -60057,8 +60749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -60076,7 +60768,7 @@ paths: type: integer secrets: type: array - items: &374 + items: &377 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -60130,16 +60822,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *372 + schema: *375 examples: - default: *373 + default: *376 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60159,15 +60851,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '200': description: Response content: application/json: - schema: *374 + schema: *377 examples: default: value: @@ -60193,9 +60885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 requestBody: required: true content: @@ -60223,7 +60915,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -60247,9 +60939,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *227 - - *228 - - *113 + - *230 + - *231 + - *116 responses: '204': description: Response @@ -60271,8 +60963,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -60446,8 +61138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -60670,8 +61362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -60754,7 +61446,7 @@ paths: - version - url additionalProperties: false - metadata: &375 + metadata: &378 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -60793,7 +61485,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *375 + metadata: *378 resolved: type: object description: A collection of resolved package dependencies. @@ -60807,7 +61499,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *375 + metadata: *378 relationship: type: string description: A notation of whether a dependency is requested @@ -60940,8 +61632,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *227 - - *228 + - *230 + - *231 - name: sha description: The SHA recorded at creation time. in: query @@ -60982,9 +61674,9 @@ paths: application/json: schema: type: array - items: *376 + items: *379 examples: - default: *377 + default: *380 headers: Link: *37 x-github: @@ -61050,8 +61742,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -61133,7 +61825,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: simple-example: summary: Simple example @@ -61206,9 +61898,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *227 - - *228 - - &378 + - *230 + - *231 + - &381 name: deployment_id description: deployment_id parameter in: path @@ -61220,7 +61912,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: default: value: @@ -61285,9 +61977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 responses: '204': description: Response @@ -61309,9 +62001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 - *17 - *18 responses: @@ -61321,7 +62013,7 @@ paths: application/json: schema: type: array - items: &379 + items: &382 title: Deployment Status description: The status of a deployment. type: object @@ -61485,9 +62177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 requestBody: required: true content: @@ -61562,9 +62254,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *382 examples: - default: &380 + default: &383 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -61620,9 +62312,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *227 - - *228 - - *378 + - *230 + - *231 + - *381 - name: status_id in: path required: true @@ -61633,9 +62325,9 @@ paths: description: Response content: application/json: - schema: *379 + schema: *382 examples: - default: *380 + default: *383 '404': *6 x-github: githubCloudOnly: false @@ -61660,8 +62352,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -61718,8 +62410,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -61737,7 +62429,7 @@ paths: - 5 environments: type: array - items: &382 + items: &385 title: Environment description: Details of a deployment environment type: object @@ -61799,7 +62491,7 @@ paths: type: string examples: - wait_timer - wait_timer: &384 + wait_timer: &387 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -61841,11 +62533,11 @@ paths: items: type: object properties: - type: *381 + type: *384 reviewer: anyOf: - *4 - - *158 + - *161 required: - id - node_id @@ -61868,7 +62560,7 @@ paths: - id - node_id - type - deployment_branch_policy: &385 + deployment_branch_policy: &388 type: - object - 'null' @@ -61985,9 +62677,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *227 - - *228 - - &383 + - *230 + - *231 + - &386 name: environment_name in: path required: true @@ -62000,9 +62692,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *385 examples: - default: &386 + default: &389 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -62086,9 +62778,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: false content: @@ -62098,7 +62790,7 @@ paths: - object - 'null' properties: - wait_timer: *384 + wait_timer: *387 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -62117,14 +62809,14 @@ paths: items: type: object properties: - type: *381 + type: *384 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *385 + deployment_branch_policy: *388 additionalProperties: false examples: default: @@ -62144,9 +62836,9 @@ paths: description: Response content: application/json: - schema: *382 + schema: *385 examples: - default: *386 + default: *389 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -62170,9 +62862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 responses: '204': description: Default response @@ -62197,9 +62889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 - *17 - *18 responses: @@ -62218,7 +62910,7 @@ paths: - 2 branch_policies: type: array - items: &387 + items: &390 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -62279,9 +62971,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: true content: @@ -62329,9 +63021,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - example-wildcard: &388 + example-wildcard: &391 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -62373,10 +63065,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - &389 + - *230 + - *231 + - *386 + - &392 name: branch_policy_id in: path required: true @@ -62388,9 +63080,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62409,10 +63101,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - *389 + - *230 + - *231 + - *386 + - *392 requestBody: required: true content: @@ -62441,9 +63133,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62462,10 +63154,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *227 - - *228 - - *383 - - *389 + - *230 + - *231 + - *386 + - *392 responses: '204': description: Response @@ -62490,9 +63182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 responses: '200': description: List of deployment protection rules @@ -62509,7 +63201,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &390 + items: &393 title: Deployment protection rule description: Deployment protection rule type: object @@ -62531,7 +63223,7 @@ paths: for the environment. examples: - true - app: &391 + app: &394 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -62634,9 +63326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#create-a-custom-deployment-protection-rule-on-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 requestBody: content: application/json: @@ -62657,9 +63349,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *390 + schema: *393 examples: - default: &392 + default: &395 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -62694,9 +63386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations-available-for-an-environment parameters: - - *383 - - *228 - - *227 + - *386 + - *231 + - *230 - *18 - *17 responses: @@ -62716,7 +63408,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *391 + items: *394 examples: default: value: @@ -62751,10 +63443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *227 - - *228 - - *383 - - &393 + - *230 + - *231 + - *386 + - &396 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -62766,9 +63458,9 @@ paths: description: Response content: application/json: - schema: *390 + schema: *393 examples: - default: *392 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62789,10 +63481,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *383 - - *228 - - *227 - - *393 + - *386 + - *231 + - *230 + - *396 responses: '204': description: Response @@ -62818,9 +63510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 - *17 - *18 responses: @@ -62838,9 +63530,9 @@ paths: type: integer secrets: type: array - items: *273 + items: *276 examples: - default: *274 + default: *277 headers: Link: *37 x-github: @@ -62865,17 +63557,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62897,18 +63589,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *394 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62930,10 +63622,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 requestBody: required: true content: @@ -62964,7 +63656,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -62990,10 +63682,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *227 - - *228 - - *383 - - *113 + - *230 + - *231 + - *386 + - *116 responses: '204': description: Default response @@ -63018,10 +63710,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *227 - - *228 - - *383 - - *249 + - *230 + - *231 + - *386 + - *252 - *18 responses: '200': @@ -63038,9 +63730,9 @@ paths: type: integer variables: type: array - items: *277 + items: *280 examples: - default: *278 + default: *281 headers: Link: *37 x-github: @@ -63063,9 +63755,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *227 - - *228 - - *383 + - *230 + - *231 + - *386 requestBody: required: true content: @@ -63092,7 +63784,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -63117,18 +63809,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *227 - - *228 - - *383 - - *116 + - *230 + - *231 + - *386 + - *119 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: *395 + default: *398 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63149,10 +63841,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *227 - - *228 - - *116 - - *383 + - *230 + - *231 + - *119 + - *386 requestBody: required: true content: @@ -63194,10 +63886,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *227 - - *228 - - *116 - - *383 + - *230 + - *231 + - *119 + - *386 responses: '204': description: Response @@ -63219,8 +63911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -63230,7 +63922,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: 200-response: value: @@ -63297,8 +63989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *227 - - *228 + - *230 + - *231 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -63320,7 +64012,7 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: default: value: @@ -63457,8 +64149,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -63491,9 +64183,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 '400': *14 '422': *15 '403': *27 @@ -63514,8 +64206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -63566,7 +64258,7 @@ paths: schema: type: string '404': *6 - '409': *125 + '409': *128 '403': *27 '422': description: Validation failed @@ -63574,8 +64266,8 @@ paths: application/json: schema: oneOf: - - *89 - - *396 + - *92 + - *399 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63600,8 +64292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *227 - - *228 + - *230 + - *231 - name: file_sha in: path required: true @@ -63653,7 +64345,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63700,8 +64392,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -63810,7 +64502,7 @@ paths: description: Response content: application/json: - schema: &397 + schema: &400 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -63981,7 +64673,7 @@ paths: type: string '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64030,15 +64722,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *227 - - *228 - - *353 + - *230 + - *231 + - *356 responses: '200': description: Response content: application/json: - schema: *397 + schema: *400 examples: default: value: @@ -64068,7 +64760,7 @@ paths: signature: payload: '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64093,9 +64785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *227 - - *228 - - &398 + - *230 + - *231 + - &401 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. @@ -64112,7 +64804,7 @@ paths: application/json: schema: type: array - items: &399 + items: &402 title: Git Reference description: Git references within a repository type: object @@ -64167,7 +64859,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64188,17 +64880,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 responses: '200': description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: &400 + default: &403 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -64208,7 +64900,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64227,8 +64919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64257,16 +64949,16 @@ paths: description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: *400 + default: *403 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64285,9 +64977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 requestBody: required: true content: @@ -64316,11 +65008,11 @@ paths: description: Response content: application/json: - schema: *399 + schema: *402 examples: - default: *400 + default: *403 '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64336,14 +65028,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *227 - - *228 - - *398 + - *230 + - *231 + - *401 responses: '204': description: Response '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64390,8 +65082,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64458,7 +65150,7 @@ paths: description: Response content: application/json: - schema: &402 + schema: &405 title: Git Tag description: Metadata for a Git tag type: object @@ -64514,7 +65206,7 @@ paths: - sha - type - url - verification: *401 + verification: *404 required: - sha - url @@ -64524,7 +65216,7 @@ paths: - tag - message examples: - default: &403 + default: &406 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -64550,7 +65242,7 @@ paths: schema: type: string '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64595,8 +65287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *227 - - *228 + - *230 + - *231 - name: tag_sha in: path required: true @@ -64607,11 +65299,11 @@ paths: description: Response content: application/json: - schema: *402 + schema: *405 examples: - default: *403 + default: *406 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64633,8 +65325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -64708,7 +65400,7 @@ paths: description: Response content: application/json: - schema: &404 + schema: &407 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -64803,7 +65495,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64826,8 +65518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *227 - - *228 + - *230 + - *231 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -64850,7 +65542,7 @@ paths: description: Response content: application/json: - schema: *404 + schema: *407 examples: default-response: summary: Default response @@ -64891,7 +65583,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64909,8 +65601,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -64920,7 +65612,7 @@ paths: application/json: schema: type: array - items: &405 + items: &408 title: Webhook description: Webhooks for repositories. type: object @@ -64983,7 +65675,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &614 + last_response: &617 title: Hook Response type: object properties: @@ -65060,8 +65752,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -65114,9 +65806,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: &406 + default: &409 value: type: Repository id: 12345678 @@ -65164,17 +65856,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '200': description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 '404': *6 x-github: githubCloudOnly: false @@ -65194,9 +65886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 requestBody: required: true content: @@ -65241,9 +65933,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 '422': *15 '404': *6 x-github: @@ -65261,9 +65953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65287,9 +65979,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '200': description: Response @@ -65316,9 +66008,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 requestBody: required: false content: @@ -65362,11 +66054,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *17 - - *147 + - *150 - name: redelivery in: query required: false @@ -65379,9 +66071,9 @@ paths: application/json: schema: type: array - items: *148 + items: *151 examples: - default: *149 + default: *152 '400': *14 '422': *15 x-github: @@ -65400,18 +66092,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *16 responses: '200': description: Response content: application/json: - schema: *150 + schema: *153 examples: - default: *151 + default: *154 '400': *14 '422': *15 x-github: @@ -65430,12 +66122,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 - *16 responses: - '202': *91 + '202': *94 '400': *14 '422': *15 x-github: @@ -65455,9 +66147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65482,9 +66174,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *227 - - *228 - - *146 + - *230 + - *231 + - *149 responses: '204': description: Response @@ -65542,14 +66234,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &407 + schema: &410 title: Import description: A repository import from an external source. type: object @@ -65656,7 +66348,7 @@ paths: - html_url - authors_url examples: - default: &410 + default: &413 value: vcs: subversion use_lfs: true @@ -65672,7 +66364,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': &408 + '503': &411 description: Unavailable due to service under maintenance. content: application/json: @@ -65701,8 +66393,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -65750,7 +66442,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: default: value: @@ -65775,7 +66467,7 @@ paths: type: string '422': *15 '404': *6 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65803,8 +66495,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -65856,7 +66548,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: example-1: summary: Example 1 @@ -65904,7 +66596,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': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65927,12 +66619,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65958,9 +66650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *227 - - *228 - - &564 + - *230 + - *231 + - &567 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -65974,7 +66666,7 @@ paths: application/json: schema: type: array - items: &409 + items: &412 title: Porter Author description: Porter Author type: object @@ -66028,7 +66720,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': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66053,8 +66745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *227 - - *228 + - *230 + - *231 - name: author_id in: path required: true @@ -66084,7 +66776,7 @@ paths: description: Response content: application/json: - schema: *409 + schema: *412 examples: default: value: @@ -66097,7 +66789,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66121,8 +66813,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66163,7 +66855,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66191,8 +66883,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -66219,11 +66911,11 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: *410 + default: *413 '422': *15 - '503': *408 + '503': *411 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66246,8 +66938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66255,8 +66947,8 @@ paths: application/json: schema: *20 examples: - default: *411 - '301': *239 + default: *414 + '301': *242 '404': *6 x-github: githubCloudOnly: false @@ -66276,8 +66968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -66285,12 +66977,12 @@ paths: application/json: schema: anyOf: - - *153 + - *156 - type: object properties: {} additionalProperties: false examples: - default: &413 + default: &416 value: limit: collaborators_only origin: repository @@ -66315,13 +67007,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: application/json: - schema: *412 + schema: *415 examples: default: summary: Example request body @@ -66333,9 +67025,9 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: - default: *413 + default: *416 '409': description: Response x-github: @@ -66357,8 +67049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -66381,8 +67073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -66392,9 +67084,9 @@ paths: application/json: schema: type: array - items: *414 + items: *417 examples: - default: &557 + default: &560 value: - id: 1 repository: @@ -66525,9 +67217,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *227 - - *228 - - *157 + - *230 + - *231 + - *160 requestBody: required: false content: @@ -66556,7 +67248,7 @@ paths: description: Response content: application/json: - schema: *414 + schema: *417 examples: default: value: @@ -66687,9 +67379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *227 - - *228 - - *157 + - *230 + - *231 + - *160 responses: '204': description: Response @@ -66720,8 +67412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *227 - - *228 + - *230 + - *231 - 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 @@ -66761,7 +67453,7 @@ paths: required: false schema: type: string - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -66774,7 +67466,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -66784,7 +67476,7 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: default: value: @@ -66934,7 +67626,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *239 + '301': *242 '422': *15 '404': *6 x-github: @@ -66963,8 +67655,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -67045,9 +67737,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: &418 + default: &421 value: id: 1 node_id: MDU6SXNzdWUx @@ -67201,9 +67893,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *57 + '503': *60 '404': *6 - '410': *236 + '410': *239 x-github: triggersNotification: true githubCloudOnly: false @@ -67231,9 +67923,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *227 - - *228 - - *78 + - *230 + - *231 + - *81 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -67243,7 +67935,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -67253,9 +67945,9 @@ paths: application/json: schema: type: array - items: *415 + items: *418 examples: - default: &420 + default: &423 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67313,17 +68005,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: &416 + default: &419 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -67377,9 +68069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -67401,9 +68093,9 @@ paths: description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: *416 + default: *419 '422': *15 x-github: githubCloudOnly: false @@ -67421,9 +68113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -67443,9 +68135,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. @@ -67471,9 +68163,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -67494,9 +68186,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -67528,16 +68220,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -67559,10 +68251,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -67582,8 +68274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -67593,7 +68285,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Issue Event description: Issue Event type: object @@ -67640,7 +68332,7 @@ paths: issue: anyOf: - type: 'null' - - *69 + - *72 label: title: Issue Event Label description: Issue Event Label @@ -67673,7 +68365,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *158 + requested_team: *161 dismissed_review: title: Issue Event Dismissed Review type: object @@ -67740,7 +68432,7 @@ paths: required: - from - to - author_association: *55 + author_association: *58 lock_reason: type: - string @@ -67932,8 +68624,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *227 - - *228 + - *230 + - *231 - name: event_id in: path required: true @@ -67944,7 +68636,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: default: value: @@ -68137,7 +68829,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *236 + '410': *239 '403': *27 x-github: githubCloudOnly: false @@ -68171,9 +68863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *227 - - *228 - - &419 + - *230 + - *231 + - &422 name: issue_number description: The number that identifies the issue. in: path @@ -68185,12 +68877,12 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 - '301': *239 + default: *421 + '301': *242 '404': *6 - '410': *236 + '410': *239 '304': *35 x-github: githubCloudOnly: false @@ -68215,9 +68907,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -68325,15 +69017,15 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 '422': *15 - '503': *57 + '503': *60 '403': *27 - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68351,9 +69043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -68379,9 +69071,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68397,9 +69089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: content: application/json: @@ -68424,9 +69116,9 @@ paths: description: Response content: application/json: - schema: *69 + schema: *72 examples: - default: *418 + default: *421 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68448,9 +69140,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - name: assignee in: path required: true @@ -68490,10 +69182,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *227 - - *228 - - *419 - - *59 + - *230 + - *231 + - *422 + - *62 - *17 - *18 responses: @@ -68503,13 +69195,13 @@ paths: application/json: schema: type: array - items: *415 + items: *418 examples: - default: *420 + default: *423 headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68538,9 +69230,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: true content: @@ -68562,16 +69254,16 @@ paths: description: Response content: application/json: - schema: *415 + schema: *418 examples: - default: *416 + default: *419 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *236 + '410': *239 '422': *15 '404': *6 x-github: @@ -68591,9 +69283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -68607,7 +69299,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &423 + - &426 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -68656,7 +69348,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &424 + - &427 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -68784,7 +69476,7 @@ paths: - performed_via_github_app - assignee - assigner - - &425 + - &428 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -68830,7 +69522,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &426 + - &429 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -68876,7 +69568,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &427 + - &430 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -68925,7 +69617,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &428 + - &431 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -68954,7 +69646,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *158 + requested_team: *161 requested_reviewer: *4 required: - review_requester @@ -68967,7 +69659,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &429 + - &432 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -68996,7 +69688,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *158 + requested_team: *161 requested_reviewer: *4 required: - review_requester @@ -69009,7 +69701,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &430 + - &433 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -69065,7 +69757,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &431 + - &434 title: Locked Issue Event description: Locked Issue Event type: object @@ -69110,7 +69802,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &432 + - &435 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -69171,7 +69863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &433 + - &436 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -69232,7 +69924,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &434 + - &437 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -69293,7 +69985,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &435 + - &438 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -69386,7 +70078,7 @@ paths: color: red headers: Link: *37 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69403,9 +70095,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -69415,7 +70107,7 @@ paths: application/json: schema: type: array - items: &421 + items: &424 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -69470,7 +70162,7 @@ paths: - color - default examples: - default: &422 + default: &425 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69488,9 +70180,9 @@ paths: default: false headers: Link: *37 - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69507,9 +70199,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69568,12 +70260,12 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 - '301': *239 + default: *425 + '301': *242 '404': *6 - '410': *236 + '410': *239 '422': *15 x-github: githubCloudOnly: false @@ -69590,9 +70282,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69652,12 +70344,12 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 - '301': *239 + default: *425 + '301': *242 '404': *6 - '410': *236 + '410': *239 '422': *15 x-github: githubCloudOnly: false @@ -69674,15 +70366,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 responses: '204': description: Response - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69701,9 +70393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - name: name in: path required: true @@ -69716,7 +70408,7 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: default: value: @@ -69727,9 +70419,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *239 + '301': *242 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69749,9 +70441,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: false content: @@ -69780,7 +70472,7 @@ paths: '204': description: Response '403': *27 - '410': *236 + '410': *239 '404': *6 '422': *15 x-github: @@ -69798,9 +70490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 responses: '204': description: Response @@ -69822,9 +70514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - 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. @@ -69850,13 +70542,13 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69874,9 +70566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 requestBody: required: true content: @@ -69908,16 +70600,16 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -69939,10 +70631,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *227 - - *228 - - *419 - - *223 + - *230 + - *231 + - *422 + - *226 responses: '204': description: Response @@ -69962,9 +70654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *227 - - *228 - - *419 + - *230 + - *231 + - *422 - *17 - *18 responses: @@ -69979,9 +70671,6 @@ paths: description: Timeline Event type: object anyOf: - - *423 - - *424 - - *425 - *426 - *427 - *428 @@ -69992,6 +70681,9 @@ paths: - *433 - *434 - *435 + - *436 + - *437 + - *438 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -70039,12 +70731,12 @@ paths: issue_url: type: string format: uri - author_association: *55 + author_association: *58 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - event - actor @@ -70075,7 +70767,7 @@ paths: properties: type: type: string - issue: *69 + issue: *72 required: - event - created_at @@ -70287,7 +70979,7 @@ paths: type: string body_text: type: string - author_association: *55 + author_association: *58 required: - event - id @@ -70310,7 +71002,7 @@ paths: type: string comments: type: array - items: &455 + items: &458 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -70415,7 +71107,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *55 + author_association: *58 _links: type: object properties: @@ -70510,7 +71202,7 @@ paths: enum: - line - file - reactions: *56 + reactions: *59 body_html: type: string examples: @@ -70548,7 +71240,7 @@ paths: type: string comments: type: array - items: *351 + items: *354 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -70823,7 +71515,7 @@ paths: headers: Link: *37 '404': *6 - '410': *236 + '410': *239 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70840,8 +71532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -70851,7 +71543,7 @@ paths: application/json: schema: type: array - items: &436 + items: &439 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -70915,8 +71607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -70952,9 +71644,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *439 examples: - default: &437 + default: &440 value: id: 1 key: ssh-rsa AAA... @@ -70987,9 +71679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *227 - - *228 - - &438 + - *230 + - *231 + - &441 name: key_id description: The unique identifier of the key. in: path @@ -71001,9 +71693,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *439 examples: - default: *437 + default: *440 '404': *6 x-github: githubCloudOnly: false @@ -71021,9 +71713,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *227 - - *228 - - *438 + - *230 + - *231 + - *441 responses: '204': description: Response @@ -71043,8 +71735,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -71054,9 +71746,9 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 + default: *425 headers: Link: *37 '404': *6 @@ -71077,8 +71769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71114,9 +71806,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: &439 + default: &442 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71148,8 +71840,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71160,9 +71852,9 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: - default: *439 + default: *442 '404': *6 x-github: githubCloudOnly: false @@ -71179,8 +71871,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71219,7 +71911,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *424 examples: default: value: @@ -71245,8 +71937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *227 - - *228 + - *230 + - *231 - name: name in: path required: true @@ -71272,8 +71964,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -71312,9 +72004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *227 - - *228 - - *328 + - *230 + - *231 + - *331 responses: '200': description: Response @@ -71380,7 +72072,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 required: - _links - git_url @@ -71461,8 +72153,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71527,8 +72219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71562,9 +72254,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *352 + schema: *355 examples: - default: *440 + default: *443 '204': description: Response when already merged '404': @@ -71589,8 +72281,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -71631,7 +72323,7 @@ paths: application/json: schema: type: array - items: *356 + items: *359 examples: default: value: @@ -71687,8 +72379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -71728,9 +72420,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: &441 + default: &444 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -71789,9 +72481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *227 - - *228 - - &442 + - *230 + - *231 + - &445 name: milestone_number description: The number that identifies the milestone. in: path @@ -71803,9 +72495,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: *441 + default: *444 '404': *6 x-github: githubCloudOnly: false @@ -71822,9 +72514,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 requestBody: required: false content: @@ -71862,9 +72554,9 @@ paths: description: Response content: application/json: - schema: *356 + schema: *359 examples: - default: *441 + default: *444 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71880,9 +72572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 responses: '204': description: Response @@ -71903,9 +72595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *227 - - *228 - - *442 + - *230 + - *231 + - *445 - *17 - *18 responses: @@ -71915,9 +72607,9 @@ paths: application/json: schema: type: array - items: *421 + items: *424 examples: - default: *422 + default: *425 headers: Link: *37 x-github: @@ -71936,12 +72628,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *227 - - *228 - - *443 - - *444 - - *59 - - *445 + - *230 + - *231 + - *446 + - *447 + - *62 + - *448 - *17 - *18 responses: @@ -71951,9 +72643,9 @@ paths: application/json: schema: type: array - items: *81 + items: *84 examples: - default: *446 + default: *449 headers: Link: *37 x-github: @@ -71977,8 +72669,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -72036,14 +72728,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: &447 + schema: &450 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -72187,7 +72879,7 @@ paths: - custom_404 - public examples: - default: &448 + default: &451 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -72228,8 +72920,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72284,11 +72976,11 @@ paths: description: Response content: application/json: - schema: *447 + schema: *450 examples: - default: *448 + default: *451 '422': *15 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72309,8 +73001,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72389,7 +73081,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72410,14 +73102,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response '422': *15 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72437,8 +73129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -72448,7 +73140,7 @@ paths: application/json: schema: type: array - items: &449 + items: &452 title: Page Build description: Page Build type: object @@ -72540,8 +73232,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *227 - - *228 + - *230 + - *231 responses: '201': description: Response @@ -72588,16 +73280,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: &450 + default: &453 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -72645,8 +73337,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *227 - - *228 + - *230 + - *231 - name: build_id in: path required: true @@ -72657,9 +73349,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *450 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72679,8 +73371,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -72789,9 +73481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *227 - - *228 - - &451 + - *230 + - *231 + - &454 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -72849,11 +73541,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *227 - - *228 - - *451 + - *230 + - *231 + - *454 responses: - '204': *128 + '204': *131 '404': *6 x-github: githubCloudOnly: false @@ -72878,8 +73570,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -73147,7 +73839,7 @@ paths: description: Empty response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -73174,8 +73866,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Private vulnerability reporting status @@ -73212,10 +73904,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: - '204': *128 + '204': *131 '422': *14 x-github: githubCloudOnly: false @@ -73234,10 +73926,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: - '204': *128 + '204': *131 '422': *14 x-github: githubCloudOnly: false @@ -73258,8 +73950,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: Indicates the state of the projects to return. in: query @@ -73280,7 +73972,7 @@ paths: application/json: schema: type: array - items: *187 + items: *190 examples: default: value: @@ -73320,7 +74012,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -73340,8 +74032,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73367,13 +74059,13 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: - default: *235 + default: *238 '401': *23 '403': *27 '404': *6 - '410': *236 + '410': *239 '422': *7 x-github: githubCloudOnly: false @@ -73393,8 +74085,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -73402,7 +74094,7 @@ paths: application/json: schema: type: array - items: *192 + items: *195 examples: default: value: @@ -73433,8 +74125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73446,7 +74138,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *192 + items: *195 required: - properties examples: @@ -73496,8 +74188,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *227 - - *228 + - *230 + - *231 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -73557,9 +74249,9 @@ paths: application/json: schema: type: array - items: *452 + items: *455 examples: - default: *453 + default: *456 headers: Link: *37 '304': *35 @@ -73591,8 +74283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -73659,7 +74351,7 @@ paths: description: Response content: application/json: - schema: &457 + schema: &460 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -73788,7 +74480,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 active_lock_reason: type: - string @@ -73843,7 +74535,7 @@ paths: type: - array - 'null' - items: *172 + items: *175 head: type: object properties: @@ -73851,7 +74543,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: *4 @@ -73868,7 +74560,7 @@ paths: type: string ref: type: string - repo: *54 + repo: *57 sha: type: string user: *4 @@ -73881,14 +74573,14 @@ paths: _links: type: object properties: - comments: *357 - commits: *357 - statuses: *357 - html: *357 - issue: *357 - review_comments: *357 - review_comment: *357 - self: *357 + comments: *360 + commits: *360 + statuses: *360 + html: *360 + issue: *360 + review_comments: *360 + review_comment: *360 + self: *360 required: - comments - commits @@ -73898,8 +74590,8 @@ paths: - review_comments - review_comment - self - author_association: *55 - auto_merge: *454 + author_association: *58 + auto_merge: *457 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -74001,7 +74693,7 @@ paths: - merged_by - review_comments examples: - default: &458 + default: &461 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -74528,8 +75220,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: sort in: query required: false @@ -74548,7 +75240,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -74558,9 +75250,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: &460 + default: &463 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74637,17 +75329,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '200': description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: &456 + default: &459 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -74722,9 +75414,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -74746,9 +75438,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: - default: *456 + default: *459 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74764,9 +75456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 responses: '204': description: Response @@ -74787,9 +75479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. @@ -74815,9 +75507,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -74838,9 +75530,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *227 - - *228 - - *68 + - *230 + - *231 + - *71 requestBody: required: true content: @@ -74872,16 +75564,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -74903,10 +75595,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *227 - - *228 - - *68 - - *223 + - *230 + - *231 + - *71 + - *226 responses: '204': description: Response @@ -74949,9 +75641,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *227 - - *228 - - &459 + - *230 + - *231 + - &462 name: pull_number description: The number that identifies the pull request. in: path @@ -74964,9 +75656,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *457 + schema: *460 examples: - default: *458 + default: *461 '304': *35 '404': *6 '406': @@ -74975,7 +75667,7 @@ paths: application/json: schema: *3 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75001,9 +75693,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75045,9 +75737,9 @@ paths: description: Response content: application/json: - schema: *457 + schema: *460 examples: - default: *458 + default: *461 '422': *15 '403': *27 x-github: @@ -75069,9 +75761,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -75132,21 +75824,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -75172,10 +75864,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *227 - - *228 - - *459 - - *78 + - *230 + - *231 + - *462 + - *81 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -75185,7 +75877,7 @@ paths: enum: - asc - desc - - *59 + - *62 - *17 - *18 responses: @@ -75195,9 +75887,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *460 + default: *463 headers: Link: *37 x-github: @@ -75230,9 +75922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -75338,7 +76030,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: example-for-a-multi-line-comment: value: @@ -75426,10 +76118,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *227 - - *228 - - *459 - - *68 + - *230 + - *231 + - *462 + - *71 requestBody: required: true content: @@ -75451,7 +76143,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: default: value: @@ -75537,9 +76229,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -75549,9 +76241,9 @@ paths: application/json: schema: type: array - items: *352 + items: *355 examples: - default: *461 + default: *464 headers: Link: *37 x-github: @@ -75581,9 +76273,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -75593,7 +76285,7 @@ paths: application/json: schema: type: array - items: *364 + items: *367 examples: default: value: @@ -75612,7 +76304,7 @@ paths: Link: *37 '422': *15 '500': *39 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75631,9 +76323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 responses: '204': description: Response if pull request has been merged @@ -75656,9 +76348,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75770,9 +76462,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 responses: '200': description: Response @@ -75788,7 +76480,7 @@ paths: items: *4 teams: type: array - items: *158 + items: *161 required: - users - teams @@ -75847,9 +76539,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -75886,7 +76578,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: default: value: @@ -76422,9 +77114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: true content: @@ -76458,7 +77150,7 @@ paths: description: Response content: application/json: - schema: *452 + schema: *455 examples: default: value: @@ -76963,9 +77655,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 - *17 - *18 responses: @@ -76975,7 +77667,7 @@ paths: application/json: schema: type: array - items: &462 + items: &465 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -77049,7 +77741,7 @@ paths: type: string body_text: type: string - author_association: *55 + author_association: *58 required: - id - node_id @@ -77131,9 +77823,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -77223,9 +77915,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &464 + default: &467 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77288,10 +77980,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - &463 + - *230 + - *231 + - *462 + - &466 name: review_id description: The unique identifier of the review. in: path @@ -77303,9 +77995,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &465 + default: &468 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -77364,10 +78056,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77390,7 +78082,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -77452,18 +78144,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 responses: '200': description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *464 + default: *467 '422': *7 '404': *6 x-github: @@ -77490,10 +78182,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 - *17 - *18 responses: @@ -77587,13 +78279,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *55 + author_association: *58 _links: type: object properties: - self: *357 - html: *357 - pull_request: *357 + self: *360 + html: *360 + pull_request: *360 required: - self - html @@ -77602,7 +78294,7 @@ paths: type: string body_html: type: string - reactions: *56 + reactions: *59 side: description: The side of the first line of the range for a multi-line comment. @@ -77744,10 +78436,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77776,7 +78468,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -77839,10 +78531,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *227 - - *228 - - *459 - - *463 + - *230 + - *231 + - *462 + - *466 requestBody: required: true content: @@ -77877,9 +78569,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *465 + default: *468 '404': *6 '422': *7 '403': *27 @@ -77901,9 +78593,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *227 - - *228 - - *459 + - *230 + - *231 + - *462 requestBody: required: false content: @@ -77967,8 +78659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *227 - - *228 + - *230 + - *231 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -77981,9 +78673,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: &467 + default: &470 value: type: file encoding: base64 @@ -78025,8 +78717,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *227 - - *228 + - *230 + - *231 - name: dir description: The alternate path to look for a README file in: path @@ -78046,9 +78738,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: *467 + default: *470 '404': *6 '422': *15 x-github: @@ -78070,8 +78762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -78081,7 +78773,7 @@ paths: application/json: schema: type: array - items: &468 + items: &471 title: Release description: A release. type: object @@ -78153,7 +78845,7 @@ paths: author: *4 assets: type: array - items: &469 + items: &472 title: Release Asset description: Data related to a release. type: object @@ -78223,7 +78915,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *56 + reactions: *59 required: - assets_url - upload_url @@ -78333,8 +79025,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -78410,9 +79102,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: &472 + default: &475 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -78513,9 +79205,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *227 - - *228 - - &470 + - *230 + - *231 + - &473 name: asset_id description: The unique identifier of the asset. in: path @@ -78527,9 +79219,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *472 examples: - default: &471 + default: &474 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 @@ -78563,7 +79255,7 @@ paths: type: User site_admin: false '404': *6 - '302': *366 + '302': *369 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78579,9 +79271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *227 - - *228 - - *470 + - *230 + - *231 + - *473 requestBody: required: false content: @@ -78610,9 +79302,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *472 examples: - default: *471 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78628,9 +79320,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *227 - - *228 - - *470 + - *230 + - *231 + - *473 responses: '204': description: Response @@ -78654,8 +79346,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -78741,16 +79433,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78767,8 +79459,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *227 - - *228 + - *230 + - *231 - name: tag description: tag parameter in: path @@ -78781,9 +79473,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 '404': *6 x-github: githubCloudOnly: false @@ -78805,9 +79497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *227 - - *228 - - &473 + - *230 + - *231 + - &476 name: release_id description: The unique identifier of the release. in: path @@ -78821,9 +79513,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: *468 + schema: *471 examples: - default: *472 + default: *475 '401': description: Unauthorized x-github: @@ -78841,9 +79533,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 requestBody: required: false content: @@ -78907,9 +79599,9 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *472 + default: *475 '404': description: Not Found if the discussion category name is invalid content: @@ -78930,9 +79622,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 responses: '204': description: Response @@ -78952,9 +79644,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - *17 - *18 responses: @@ -78964,7 +79656,7 @@ paths: application/json: schema: type: array - items: *469 + items: *472 examples: default: value: @@ -79044,9 +79736,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: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - name: name in: query required: true @@ -79072,7 +79764,7 @@ paths: description: Response for successful upload content: application/json: - schema: *469 + schema: *472 examples: response-for-successful-upload: value: @@ -79126,9 +79818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 - 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. @@ -79152,9 +79844,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 '404': *6 @@ -79175,9 +79867,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *227 - - *228 - - *473 + - *230 + - *231 + - *476 requestBody: required: true content: @@ -79207,16 +79899,16 @@ paths: description: Reaction exists content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '201': description: Reaction created content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 '422': *15 x-github: githubCloudOnly: false @@ -79238,10 +79930,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *227 - - *228 - - *473 - - *223 + - *230 + - *231 + - *476 + - *226 responses: '204': description: Response @@ -79265,9 +79957,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *227 - - *228 - - *295 + - *230 + - *231 + - *298 - *17 - *18 responses: @@ -79283,8 +79975,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *474 - - &476 + - *477 + - &479 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -79303,54 +79995,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *475 - - *476 - - allOf: - - *477 - - *476 - allOf: - *478 - - *476 - - allOf: - *479 - - *476 - allOf: - *480 - - *476 + - *479 - allOf: - *481 - - *476 + - *479 - allOf: - *482 - - *476 + - *479 - allOf: - *483 - - *476 + - *479 - allOf: - *484 - - *476 + - *479 - allOf: - *485 - - *476 + - *479 - allOf: - *486 - - *476 + - *479 - allOf: - *487 - - *476 + - *479 - allOf: - *488 - - *476 + - *479 - allOf: - *489 - - *476 + - *479 - allOf: - *490 - - *476 + - *479 - allOf: - *491 - - *476 + - *479 + - allOf: + - *492 + - *479 + - allOf: + - *493 + - *479 + - allOf: + - *494 + - *479 examples: default: value: @@ -79389,8 +80081,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 - name: includes_parents @@ -79401,7 +80093,7 @@ paths: schema: type: boolean default: true - - *492 + - *495 responses: '200': description: Response @@ -79409,7 +80101,7 @@ paths: application/json: schema: type: array - items: *200 + items: *203 examples: default: value: @@ -79456,8 +80148,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 requestBody: description: Request body required: true @@ -79477,16 +80169,16 @@ paths: - tag - push default: branch - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *194 + items: *200 + conditions: *197 rules: type: array description: An array of rules within the ruleset. - items: *199 + items: *202 required: - name - enforcement @@ -79517,9 +80209,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: &502 + default: &505 value: id: 42 name: super cool ruleset @@ -79566,12 +80258,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *227 - - *228 - - *493 - - *494 - - *495 + - *230 + - *231 - *496 + - *497 + - *498 + - *499 - *17 - *18 responses: @@ -79579,9 +80271,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: *498 + default: *501 '404': *6 '500': *39 x-github: @@ -79602,17 +80294,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *227 - - *228 - - *499 + - *230 + - *231 + - *502 responses: '200': description: Response content: application/json: - schema: *500 + schema: *503 examples: - default: *501 + default: *504 '404': *6 '500': *39 x-github: @@ -79640,8 +80332,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79661,9 +80353,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *502 + default: *505 '404': *6 '500': *39 put: @@ -79681,8 +80373,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79707,16 +80399,16 @@ paths: - branch - tag - push - enforcement: *196 + enforcement: *199 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *197 - conditions: *194 + items: *200 + conditions: *197 rules: description: An array of rules within the ruleset. type: array - items: *199 + items: *202 examples: default: value: @@ -79744,9 +80436,9 @@ paths: description: Response content: application/json: - schema: *200 + schema: *203 examples: - default: *502 + default: *505 '404': *6 '500': *39 delete: @@ -79764,8 +80456,8 @@ paths: category: repos subcategory: rules parameters: - - *227 - - *228 + - *230 + - *231 - name: ruleset_id description: The ID of the ruleset. in: path @@ -79793,20 +80485,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *227 - - *228 - - *202 - - *203 - - *204 + - *230 + - *231 - *205 - - *40 - - *18 - - *17 - - *503 - - *504 - *206 - *207 - *208 + - *40 + - *18 + - *17 + - *506 + - *507 + - *209 + - *210 + - *211 responses: '200': description: Response @@ -79814,7 +80506,7 @@ paths: application/json: schema: type: array - items: &507 + items: &510 type: object properties: number: *46 @@ -79830,8 +80522,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *505 - resolution: *506 + state: *508 + resolution: *509 resolved_at: type: - string @@ -79974,7 +80666,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79996,15 +80688,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 responses: '200': description: Response content: application/json: - schema: *507 + schema: *510 examples: default: value: @@ -80031,7 +80723,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80052,9 +80744,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 requestBody: required: true content: @@ -80062,8 +80754,8 @@ paths: schema: type: object properties: - state: *505 - resolution: *506 + state: *508 + resolution: *509 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -80082,7 +80774,7 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: default: value: @@ -80131,7 +80823,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80153,9 +80845,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *227 - - *228 - - *326 + - *230 + - *231 + - *329 - *18 - *17 responses: @@ -80166,7 +80858,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &635 + items: &638 type: object properties: type: @@ -80523,7 +81215,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80545,8 +81237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -80554,14 +81246,14 @@ paths: schema: type: object properties: - reason: &509 + reason: &512 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *508 + placeholder_id: *511 required: - reason - placeholder_id @@ -80578,7 +81270,7 @@ paths: schema: type: object properties: - reason: *509 + reason: *512 expire_at: type: - string @@ -80602,7 +81294,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *57 + '503': *60 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -80624,8 +81316,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *227 - - *228 + - *230 + - *231 - *40 - name: sort description: The property to sort the results by. @@ -80669,9 +81361,9 @@ paths: application/json: schema: type: array - items: *510 + items: *513 examples: - default: *511 + default: *514 '400': *14 '404': *6 x-github: @@ -80694,8 +81386,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -80775,7 +81467,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 required: - login - type @@ -80865,9 +81557,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: &513 + default: &516 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -81100,8 +81792,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -81214,7 +81906,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: default: value: @@ -81361,17 +82053,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: '200': description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *513 + default: *516 '403': *27 '404': *6 x-github: @@ -81395,9 +82087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 requestBody: required: true content: @@ -81477,7 +82169,7 @@ paths: login: type: string description: The username of the user credited. - type: *211 + type: *214 required: - login - type @@ -81568,17 +82260,17 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *513 - add_credit: *513 + default: *516 + add_credit: *516 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *89 + schema: *92 examples: invalid_state_transition: value: @@ -81609,11 +82301,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: - '202': *91 + '202': *94 '400': *14 '403': *27 '404': *6 @@ -81638,17 +82330,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *227 - - *228 - - *512 + - *230 + - *231 + - *515 responses: '202': description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 '400': *14 '422': *15 '403': *27 @@ -81674,8 +82366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -81771,8 +82463,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -81781,7 +82473,7 @@ paths: application/json: schema: type: array - items: &514 + items: &517 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -81793,8 +82485,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *91 - '204': *128 + '202': *94 + '204': *131 '422': description: Repository contains more than 10,000 commits x-github: @@ -81814,8 +82506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -81865,8 +82557,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *91 - '204': *128 + '202': *94 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81893,8 +82585,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -81965,8 +82657,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *91 - '204': *128 + '202': *94 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81988,8 +82680,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -82143,8 +82835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -82154,7 +82846,7 @@ paths: application/json: schema: type: array - items: *514 + items: *517 examples: default: value: @@ -82167,7 +82859,7 @@ paths: - - 0 - 2 - 21 - '204': *128 + '204': *131 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82187,8 +82879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *227 - - *228 + - *230 + - *231 - name: sha in: path required: true @@ -82244,7 +82936,7 @@ paths: description: Response content: application/json: - schema: *515 + schema: *518 examples: default: value: @@ -82298,8 +82990,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82311,7 +83003,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -82331,14 +83023,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &516 + schema: &519 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -82411,8 +83103,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: false content: @@ -82438,7 +83130,7 @@ paths: description: Response content: application/json: - schema: *516 + schema: *519 examples: default: value: @@ -82465,8 +83157,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -82486,8 +83178,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82569,8 +83261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -82578,7 +83270,7 @@ paths: application/json: schema: type: array - items: &517 + items: &520 title: Tag protection description: Tag protection type: object @@ -82635,8 +83327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -82659,7 +83351,7 @@ paths: description: Response content: application/json: - schema: *517 + schema: *520 examples: default: value: @@ -82690,8 +83382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -82728,8 +83420,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *227 - - *228 + - *230 + - *231 - name: ref in: path required: true @@ -82765,8 +83457,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *227 - - *228 + - *230 + - *231 - *17 - *18 responses: @@ -82776,9 +83468,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *173 + default: *176 headers: Link: *37 '404': *6 @@ -82798,8 +83490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *227 - - *228 + - *230 + - *231 - *18 - *17 responses: @@ -82807,7 +83499,7 @@ paths: description: Response content: application/json: - schema: &518 + schema: &521 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -82819,7 +83511,7 @@ paths: required: - names examples: - default: &519 + default: &522 value: names: - octocat @@ -82842,8 +83534,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -82874,9 +83566,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: *519 + default: *522 '404': *6 '422': *7 x-github: @@ -82897,9 +83589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *227 - - *228 - - &520 + - *230 + - *231 + - &523 name: per description: The time frame to display results for. in: query @@ -82930,7 +83622,7 @@ paths: - 128 clones: type: array - items: &521 + items: &524 title: Traffic type: object properties: @@ -83017,8 +83709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -83112,8 +83804,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *227 - - *228 + - *230 + - *231 responses: '200': description: Response @@ -83176,9 +83868,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *227 - - *228 - - *520 + - *230 + - *231 + - *523 responses: '200': description: Response @@ -83199,7 +83891,7 @@ paths: - 3782 views: type: array - items: *521 + items: *524 required: - uniques - count @@ -83276,8 +83968,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *227 - - *228 + - *230 + - *231 requestBody: required: true content: @@ -83313,7 +84005,7 @@ paths: description: Response content: application/json: - schema: *105 + schema: *108 examples: default: value: @@ -83551,8 +84243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -83575,8 +84267,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -83598,8 +84290,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -83625,8 +84317,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *227 - - *228 + - *230 + - *231 - name: ref in: path required: true @@ -83718,9 +84410,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -83761,7 +84453,7 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: default: value: @@ -83950,7 +84642,7 @@ paths: html_url: type: string format: uri - repository: *105 + repository: *108 score: type: number file_size: @@ -83969,7 +84661,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &522 + text_matches: &525 title: Search Result Text Matches type: array items: @@ -84084,7 +84776,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *57 + '503': *60 '422': *15 '403': *27 x-github: @@ -84132,7 +84824,7 @@ paths: enum: - author-date - committer-date - - &523 + - &526 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 @@ -84201,7 +84893,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 comment_count: type: integer message: @@ -84220,7 +84912,7 @@ paths: url: type: string format: uri - verification: *401 + verification: *404 required: - author - committer @@ -84235,7 +84927,7 @@ paths: committer: anyOf: - type: 'null' - - *293 + - *296 parents: type: array items: @@ -84247,12 +84939,12 @@ paths: type: string sha: type: string - repository: *105 + repository: *108 score: type: number node_id: type: string - text_matches: *522 + text_matches: *525 required: - sha - node_id @@ -84444,7 +85136,7 @@ paths: - interactions - created - updated - - *523 + - *526 - *17 - *18 responses: @@ -84546,7 +85238,7 @@ paths: milestone: anyOf: - type: 'null' - - *356 + - *359 comments: type: integer created_at: @@ -84560,7 +85252,7 @@ paths: - string - 'null' format: date-time - text_matches: *522 + text_matches: *525 pull_request: type: object properties: @@ -84598,10 +85290,10 @@ paths: type: string score: type: number - author_association: *55 + author_association: *58 draft: type: boolean - repository: *54 + repository: *57 body_html: type: string body_text: @@ -84613,7 +85305,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *56 + reactions: *59 required: - assignee - closed_at @@ -84729,7 +85421,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *57 + '503': *60 '422': *15 '304': *35 '403': *27 @@ -84782,7 +85474,7 @@ paths: enum: - created - updated - - *523 + - *526 - *17 - *18 responses: @@ -84827,7 +85519,7 @@ paths: - 'null' score: type: number - text_matches: *522 + text_matches: *525 required: - id - node_id @@ -84912,7 +85604,7 @@ paths: - forks - help-wanted-issues - updated - - *523 + - *526 - *17 - *18 responses: @@ -85131,7 +85823,7 @@ paths: license: anyOf: - type: 'null' - - *70 + - *73 permissions: type: object properties: @@ -85149,7 +85841,7 @@ paths: - admin - pull - push - text_matches: *522 + text_matches: *525 temp_clone_token: type: string allow_merge_commit: @@ -85352,7 +86044,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *57 + '503': *60 '422': *15 '304': *35 x-github: @@ -85457,7 +86149,7 @@ paths: - string - 'null' format: uri - text_matches: *522 + text_matches: *525 related: type: - array @@ -85650,7 +86342,7 @@ paths: - followers - repositories - joined - - *523 + - *526 - *17 - *18 responses: @@ -85760,7 +86452,7 @@ paths: type: - boolean - 'null' - text_matches: *522 + text_matches: *525 blog: type: - string @@ -85822,7 +86514,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *57 + '503': *60 '422': *15 x-github: githubCloudOnly: false @@ -85842,7 +86534,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &524 + - &527 name: team_id description: The unique identifier of the team. in: path @@ -85854,9 +86546,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 x-github: githubCloudOnly: false @@ -85883,7 +86575,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *524 + - *527 requestBody: required: true content: @@ -85947,16 +86639,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '201': description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *6 '422': *15 '403': *27 @@ -85984,7 +86676,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *524 + - *527 responses: '204': description: Response @@ -86015,7 +86707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *524 + - *527 - *40 - *17 - *18 @@ -86026,9 +86718,9 @@ paths: application/json: schema: type: array - items: *214 + items: *217 examples: - default: *525 + default: *528 headers: Link: *37 x-github: @@ -86057,7 +86749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *524 + - *527 requestBody: required: true content: @@ -86091,9 +86783,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: triggersNotification: true githubCloudOnly: false @@ -86120,16 +86812,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 responses: '200': description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *215 + default: *218 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86154,8 +86846,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: false content: @@ -86178,9 +86870,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - default: *526 + default: *529 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86205,8 +86897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 responses: '204': description: Response @@ -86235,8 +86927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *524 - - *216 + - *527 + - *219 - *40 - *17 - *18 @@ -86247,9 +86939,9 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: - default: *527 + default: *530 headers: Link: *37 x-github: @@ -86278,8 +86970,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: true content: @@ -86301,9 +86993,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: triggersNotification: true githubCloudOnly: false @@ -86330,17 +87022,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *218 + default: *221 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86365,9 +87057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 requestBody: required: true content: @@ -86389,9 +87081,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: - default: *528 + default: *531 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86416,9 +87108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 responses: '204': description: Response @@ -86447,9 +87139,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. @@ -86475,9 +87167,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -86506,9 +87198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *524 - - *216 + - *527 - *219 + - *222 requestBody: required: true content: @@ -86540,9 +87232,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86568,8 +87260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 - name: content description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. @@ -86595,9 +87287,9 @@ paths: application/json: schema: type: array - items: *220 + items: *223 examples: - default: *222 + default: *225 headers: Link: *37 x-github: @@ -86626,8 +87318,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *524 - - *216 + - *527 + - *219 requestBody: required: true content: @@ -86659,9 +87351,9 @@ paths: description: Response content: application/json: - schema: *220 + schema: *223 examples: - default: *221 + default: *224 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86685,7 +87377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -86695,9 +87387,9 @@ paths: application/json: schema: type: array - items: *155 + items: *158 examples: - default: *156 + default: *159 headers: Link: *37 x-github: @@ -86723,7 +87415,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *524 + - *527 - name: role description: Filters members returned by their role in the team. in: query @@ -86746,7 +87438,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '404': *6 @@ -86774,8 +87466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: if user is a member @@ -86811,8 +87503,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -86851,8 +87543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -86888,16 +87580,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '200': description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-user-is-a-team-maintainer: *529 + response-if-user-is-a-team-maintainer: *532 '404': *6 x-github: githubCloudOnly: false @@ -86930,8 +87622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 requestBody: required: false content: @@ -86956,9 +87648,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - response-if-users-membership-with-team-is-now-pending: *530 + response-if-users-membership-with-team-is-now-pending: *533 '403': description: Forbidden if team synchronization is set up '422': @@ -86992,8 +87684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *524 - - *118 + - *527 + - *121 responses: '204': description: Response @@ -87022,7 +87714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87032,9 +87724,9 @@ paths: application/json: schema: type: array - items: *225 + items: *228 examples: - default: *531 + default: *534 headers: Link: *37 '404': *6 @@ -87061,16 +87753,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *524 - - *226 + - *527 + - *229 responses: '200': description: Response content: application/json: - schema: *225 + schema: *228 examples: - default: *532 + default: *535 '404': description: Not Found if project is not managed by this team x-github: @@ -87095,8 +87787,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *524 - - *226 + - *527 + - *229 requestBody: required: false content: @@ -87164,8 +87856,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *524 - - *226 + - *527 + - *229 responses: '204': description: Response @@ -87192,7 +87884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87202,9 +87894,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '404': *6 @@ -87234,15 +87926,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *533 + schema: *536 examples: alternative-response-with-extra-repository-information: value: @@ -87393,9 +88085,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 requestBody: required: false content: @@ -87445,9 +88137,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *524 - - *227 - - *228 + - *527 + - *230 + - *231 responses: '204': description: Response @@ -87472,7 +88164,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *524 + - *527 - *17 - *18 responses: @@ -87482,9 +88174,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - response-if-child-teams-exist: *534 + response-if-child-teams-exist: *537 headers: Link: *37 '404': *6 @@ -87517,7 +88209,7 @@ paths: application/json: schema: oneOf: - - &536 + - &539 title: Private User description: Private User type: object @@ -87767,7 +88459,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *535 + - *538 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -87927,7 +88619,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *539 examples: default: value: @@ -88006,7 +88698,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 '304': *35 '404': *6 '403': *27 @@ -88029,7 +88721,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: If the user is blocked @@ -88057,7 +88749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -88081,7 +88773,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -88130,9 +88822,9 @@ paths: type: integer codespaces: type: array - items: *162 + items: *165 examples: - default: *163 + default: *166 '304': *35 '500': *39 '401': *23 @@ -88271,21 +88963,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 - '503': *57 + '503': *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88325,7 +89017,7 @@ paths: type: integer secrets: type: array - items: &537 + items: &540 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -88367,7 +89059,7 @@ paths: - visibility - selected_repositories_url examples: - default: *345 + default: *348 headers: Link: *37 x-github: @@ -88439,13 +89131,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 responses: '200': description: Response content: application/json: - schema: *537 + schema: *540 examples: default: value: @@ -88475,7 +89167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 requestBody: required: true content: @@ -88520,7 +89212,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -88548,7 +89240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *113 + - *116 responses: '204': description: Response @@ -88573,7 +89265,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *113 + - *116 responses: '200': description: Response @@ -88589,9 +89281,9 @@ paths: type: integer repositories: type: array - items: *105 + items: *108 examples: - default: *538 + default: *541 '401': *23 '403': *27 '404': *6 @@ -88616,7 +89308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *113 + - *116 requestBody: required: true content: @@ -88670,7 +89362,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *113 + - *116 - name: repository_id in: path required: true @@ -88703,7 +89395,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *113 + - *116 - name: repository_id in: path required: true @@ -88735,15 +89427,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '304': *35 '500': *39 '401': *23 @@ -88769,7 +89461,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 requestBody: required: false content: @@ -88799,9 +89491,9 @@ paths: description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '401': *23 '403': *27 '404': *6 @@ -88823,9 +89515,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: - '202': *91 + '202': *94 '304': *35 '500': *39 '401': *23 @@ -88852,13 +89544,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '202': description: Response content: application/json: - schema: &539 + schema: &542 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -88911,7 +89603,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &540 + default: &543 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -88943,7 +89635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *164 + - *167 - name: export_id in: path required: true @@ -88956,9 +89648,9 @@ paths: description: Response content: application/json: - schema: *539 + schema: *542 examples: - default: *540 + default: *543 '404': *6 x-github: githubCloudOnly: false @@ -88979,7 +89671,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *164 + - *167 responses: '200': description: Response @@ -88995,9 +89687,9 @@ paths: type: integer machines: type: array - items: *344 + items: *347 examples: - default: *541 + default: *544 '304': *35 '500': *39 '401': *23 @@ -89026,7 +89718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *164 + - *167 requestBody: required: true content: @@ -89082,11 +89774,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *238 + repository: *241 machine: anyOf: - type: 'null' - - *344 + - *347 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -89883,15 +90575,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '304': *35 '500': *39 '400': *14 @@ -89903,7 +90595,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *125 + '409': *128 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -89923,15 +90615,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *164 + - *167 responses: '200': description: Response content: application/json: - schema: *162 + schema: *165 examples: - default: *343 + default: *346 '500': *39 '401': *23 '403': *27 @@ -89961,9 +90653,9 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: &554 + default: &557 value: - id: 197 name: hello_docker @@ -90064,7 +90756,7 @@ paths: application/json: schema: type: array - items: &542 + items: &545 title: Email description: Email type: object @@ -90134,9 +90826,9 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: - default: &556 + default: &559 value: - email: octocat@github.com verified: true @@ -90213,7 +90905,7 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: default: value: @@ -90325,7 +91017,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '304': *35 @@ -90358,7 +91050,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 '304': *35 @@ -90380,7 +91072,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: if the person is followed by the authenticated user @@ -90410,7 +91102,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -90434,7 +91126,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -90470,7 +91162,7 @@ paths: application/json: schema: type: array - items: &543 + items: &546 title: GPG Key description: A unique encryption key type: object @@ -90615,7 +91307,7 @@ paths: - subkeys - revoked examples: - default: &567 + default: &570 value: - id: 3 name: Octocat's GPG Key @@ -90700,9 +91392,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *546 examples: - default: &544 + default: &547 value: id: 3 name: Octocat's GPG Key @@ -90759,7 +91451,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &545 + - &548 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -90771,9 +91463,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *546 examples: - default: *544 + default: *547 '404': *6 '304': *35 '403': *27 @@ -90796,7 +91488,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *545 + - *548 responses: '204': description: Response @@ -90985,9 +91677,9 @@ paths: type: string repositories: type: array - items: *54 + items: *57 examples: - default: *546 + default: *549 headers: Link: *37 '404': *6 @@ -91012,7 +91704,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *96 + - *99 responses: '204': description: Response @@ -91038,7 +91730,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *96 + - *99 responses: '204': description: Response @@ -91072,12 +91764,12 @@ paths: application/json: schema: anyOf: - - *153 + - *156 - type: object properties: {} additionalProperties: false examples: - default: *154 + default: *157 '204': description: Response when there are no restrictions x-github: @@ -91101,7 +91793,7 @@ paths: required: true content: application/json: - schema: *412 + schema: *415 examples: default: value: @@ -91112,7 +91804,7 @@ paths: description: Response content: application/json: - schema: *153 + schema: *156 examples: default: value: @@ -91193,7 +91885,7 @@ paths: - closed - all default: open - - *159 + - *162 - name: sort description: What to sort results by. in: query @@ -91206,7 +91898,7 @@ paths: - comments default: created - *40 - - *59 + - *62 - *17 - *18 responses: @@ -91216,9 +91908,9 @@ paths: application/json: schema: type: array - items: *69 + items: *72 examples: - default: *160 + default: *163 headers: Link: *37 '404': *6 @@ -91251,7 +91943,7 @@ paths: application/json: schema: type: array - items: &547 + items: &550 title: Key description: Key type: object @@ -91349,9 +92041,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *550 examples: - default: &548 + default: &551 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91384,15 +92076,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *438 + - *441 responses: '200': description: Response content: application/json: - schema: *547 + schema: *550 examples: - default: *548 + default: *551 '404': *6 '304': *35 '403': *27 @@ -91415,7 +92107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *438 + - *441 responses: '204': description: Response @@ -91448,7 +92140,7 @@ paths: application/json: schema: type: array - items: &549 + items: &552 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -91516,7 +92208,7 @@ paths: - id - type - login - plan: *72 + plan: *75 required: - billing_cycle - next_billing_date @@ -91527,7 +92219,7 @@ paths: - account - plan examples: - default: &550 + default: &553 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -91589,9 +92281,9 @@ paths: application/json: schema: type: array - items: *549 + items: *552 examples: - default: *550 + default: *553 headers: Link: *37 '304': *35 @@ -91631,7 +92323,7 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: default: value: @@ -91733,13 +92425,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -91797,7 +92489,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *86 + - *89 requestBody: required: true content: @@ -91822,7 +92514,7 @@ paths: description: Response content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -91890,7 +92582,7 @@ paths: application/json: schema: type: array - items: *167 + items: *170 examples: default: value: @@ -92152,7 +92844,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -92332,7 +93024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *168 + - *171 - name: exclude in: query required: false @@ -92345,7 +93037,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -92539,7 +93231,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *168 + - *171 responses: '302': description: Response @@ -92565,7 +93257,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *168 + - *171 responses: '204': description: Response @@ -92594,8 +93286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *168 - - *551 + - *171 + - *554 responses: '204': description: Response @@ -92619,7 +93311,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *168 + - *171 - *17 - *18 responses: @@ -92629,9 +93321,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '404': *6 @@ -92666,9 +93358,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *552 + default: *555 headers: Link: *37 '304': *35 @@ -92710,7 +93402,7 @@ paths: - docker - nuget - container - - *553 + - *556 - *18 - *17 responses: @@ -92720,10 +93412,10 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 - '400': *555 + default: *557 + '400': *558 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92743,16 +93435,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: - default: &568 + default: &571 value: id: 40201 name: octo-name @@ -92865,8 +93557,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 responses: '204': description: Response @@ -92896,8 +93588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *176 - - *177 + - *179 + - *180 - name: token description: package token schema: @@ -92929,8 +93621,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: - - *176 - - *177 + - *179 + - *180 - *18 - *17 - name: state @@ -92950,7 +93642,7 @@ paths: application/json: schema: type: array - items: *178 + items: *181 examples: default: value: @@ -92999,15 +93691,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '200': description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -93043,9 +93735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '204': description: Response @@ -93075,9 +93767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *176 - - *177 - *179 + - *180 + - *182 responses: '204': description: Response @@ -93135,7 +93827,7 @@ paths: description: Response content: application/json: - schema: *187 + schema: *190 examples: default: value: @@ -93204,9 +93896,9 @@ paths: application/json: schema: type: array - items: *542 + items: *545 examples: - default: *556 + default: *559 headers: Link: *37 '304': *35 @@ -93317,9 +94009,9 @@ paths: application/json: schema: type: array - items: *54 + items: *57 examples: - default: &563 + default: &566 summary: Default response value: - id: 1296269 @@ -93635,9 +94327,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *241 examples: - default: *240 + default: *243 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -93675,9 +94367,9 @@ paths: application/json: schema: type: array - items: *414 + items: *417 examples: - default: *557 + default: *560 headers: Link: *37 '304': *35 @@ -93700,12 +94392,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *157 + - *160 responses: '204': description: Response '403': *27 - '409': *125 + '409': *128 '404': *6 '304': *35 x-github: @@ -93723,11 +94415,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *157 + - *160 responses: '204': description: Response - '409': *125 + '409': *128 '304': *35 '404': *6 '403': *27 @@ -93756,7 +94448,7 @@ paths: application/json: schema: type: array - items: &558 + items: &561 title: Social account description: Social media account type: object @@ -93773,7 +94465,7 @@ paths: - provider - url examples: - default: &559 + default: &562 value: - provider: twitter url: https://twitter.com/github @@ -93836,9 +94528,9 @@ paths: application/json: schema: type: array - items: *558 + items: *561 examples: - default: *559 + default: *562 '422': *15 '304': *35 '404': *6 @@ -93926,7 +94618,7 @@ paths: application/json: schema: type: array - items: &560 + items: &563 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -93946,7 +94638,7 @@ paths: - title - created_at examples: - default: &575 + default: &578 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94013,9 +94705,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: &561 + default: &564 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -94046,7 +94738,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: - - &562 + - &565 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -94058,9 +94750,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: *561 + default: *564 '404': *6 '304': *35 '403': *27 @@ -94083,7 +94775,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: - - *562 + - *565 responses: '204': description: Response @@ -94112,7 +94804,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &576 + - &579 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 @@ -94135,13 +94827,13 @@ paths: application/json: schema: type: array - items: *54 + items: *57 examples: - default-response: *563 + default-response: *566 application/vnd.github.v3.star+json: schema: type: array - items: &577 + items: &580 title: Starred Repository description: Starred Repository type: object @@ -94149,7 +94841,7 @@ paths: starred_at: type: string format: date-time - repo: *54 + repo: *57 required: - starred_at - repo @@ -94297,8 +94989,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response if this repository is starred by you @@ -94326,8 +95018,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -94351,8 +95043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *227 - - *228 + - *230 + - *231 responses: '204': description: Response @@ -94385,9 +95077,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 '304': *35 @@ -94424,7 +95116,7 @@ paths: application/json: schema: type: array - items: *212 + items: *215 examples: default: value: @@ -94500,7 +95192,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *74 + - *77 responses: '200': description: Response @@ -94508,10 +95200,10 @@ paths: application/json: schema: oneOf: - - *536 - - *535 + - *539 + - *538 examples: - default-response: &565 + default-response: &568 summary: Default response value: login: octocat @@ -94546,7 +95238,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &566 + response-with-git-hub-plan-information: &569 summary: Response with GitHub plan information value: login: octocat @@ -94606,7 +95298,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *564 + - *567 - *17 responses: '200': @@ -94617,7 +95309,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: example: ; rel="next" @@ -94645,7 +95337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *118 + - *121 responses: '200': description: Response @@ -94653,11 +95345,11 @@ paths: application/json: schema: oneOf: - - *536 - - *535 + - *539 + - *538 examples: - default-response: *565 - response-with-git-hub-plan-information: *566 + default-response: *568 + response-with-git-hub-plan-information: *569 '404': *6 x-github: githubCloudOnly: false @@ -94683,7 +95375,7 @@ paths: - *17 - *41 - *42 - - *118 + - *121 - name: subject_digest description: Subject Digest in: path @@ -94785,7 +95477,7 @@ paths: description: Response content: application/json: - schema: *114 + schema: *117 examples: default: value: @@ -94811,7 +95503,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *118 + - *121 responses: '200': description: Response @@ -94819,9 +95511,9 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 + default: *557 '403': *27 '401': *23 x-github: @@ -94844,7 +95536,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -94854,7 +95546,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -94925,8 +95617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *118 - - *86 + - *121 + - *89 - *17 - *18 responses: @@ -94936,7 +95628,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95015,7 +95707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95025,7 +95717,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95092,7 +95784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95104,7 +95796,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -95123,7 +95815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95135,7 +95827,7 @@ paths: type: array items: *4 examples: - default: *161 + default: *164 headers: Link: *37 x-github: @@ -95154,7 +95846,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *118 + - *121 - name: target_user in: path required: true @@ -95181,8 +95873,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *118 - - *59 + - *121 + - *62 - *17 - *18 responses: @@ -95192,9 +95884,9 @@ paths: application/json: schema: type: array - items: *60 + items: *63 examples: - default: *61 + default: *64 headers: Link: *37 '422': *15 @@ -95215,7 +95907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95225,9 +95917,9 @@ paths: application/json: schema: type: array - items: *543 + items: *546 examples: - default: *567 + default: *570 headers: Link: *37 x-github: @@ -95251,7 +95943,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *118 + - *121 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -95323,7 +96015,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *118 + - *121 responses: '200': description: Response @@ -95331,7 +96023,7 @@ paths: application/json: schema: *20 examples: - default: *411 + default: *414 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95349,7 +96041,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95397,7 +96089,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95407,9 +96099,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *552 + default: *555 headers: Link: *37 x-github: @@ -95448,8 +96140,8 @@ paths: - docker - nuget - container - - *553 - - *118 + - *556 + - *121 - *18 - *17 responses: @@ -95459,12 +96151,12 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: - default: *554 + default: *557 '403': *27 '401': *23 - '400': *555 + '400': *558 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95484,17 +96176,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: - default: *568 + default: *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95515,9 +96207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '204': description: Response @@ -95549,9 +96241,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 - name: token description: package token schema: @@ -95583,9 +96275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *176 - - *177 - - *118 + - *179 + - *180 + - *121 responses: '200': description: Response @@ -95593,7 +96285,7 @@ paths: application/json: schema: type: array - items: *178 + items: *181 examples: default: value: @@ -95651,16 +96343,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *176 - - *177 - *179 - - *118 + - *180 + - *182 + - *121 responses: '200': description: Response content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -95695,10 +96387,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *176 - - *177 - - *118 - *179 + - *180 + - *121 + - *182 responses: '204': description: Response @@ -95730,10 +96422,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *176 - - *177 - - *118 - *179 + - *180 + - *121 + - *182 responses: '204': description: Response @@ -95756,7 +96448,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *118 + - *121 - name: state description: Indicates the state of the projects to return. in: query @@ -95777,7 +96469,7 @@ paths: application/json: schema: type: array - items: *187 + items: *190 examples: default: value: @@ -95836,7 +96528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95846,7 +96538,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -95925,7 +96617,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -95935,7 +96627,7 @@ paths: application/json: schema: type: array - items: *80 + items: *83 examples: default: value: @@ -96012,7 +96704,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *118 + - *121 - name: type description: Limit results to repositories of the specified type. in: query @@ -96055,9 +96747,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -96081,15 +96773,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *569 + schema: *572 examples: - default: *570 + default: *573 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96111,15 +96803,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *571 + schema: *574 examples: - default: *572 + default: *575 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96141,15 +96833,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *574 + default: *577 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96167,7 +96859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96177,9 +96869,9 @@ paths: application/json: schema: type: array - items: *558 + items: *561 examples: - default: *559 + default: *562 headers: Link: *37 x-github: @@ -96199,7 +96891,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96209,9 +96901,9 @@ paths: application/json: schema: type: array - items: *560 + items: *563 examples: - default: *575 + default: *578 headers: Link: *37 x-github: @@ -96235,8 +96927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *118 - - *576 + - *121 + - *579 - *40 - *17 - *18 @@ -96248,11 +96940,11 @@ paths: schema: anyOf: - type: array - items: *577 + items: *580 - type: array - items: *54 + items: *57 examples: - default-response: *563 + default-response: *566 headers: Link: *37 x-github: @@ -96271,7 +96963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *118 + - *121 - *17 - *18 responses: @@ -96281,9 +96973,9 @@ paths: application/json: schema: type: array - items: *105 + items: *108 examples: - default: *180 + default: *183 headers: Link: *37 x-github: @@ -96412,7 +97104,7 @@ webhooks: type: string enum: - disabled - enterprise: &578 + enterprise: &581 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -96481,7 +97173,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &579 + installation: &582 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -96502,7 +97194,7 @@ webhooks: required: - id - node_id - organization: &580 + organization: &583 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -96575,7 +97267,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &581 + repository: &584 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -96604,7 +97296,7 @@ webhooks: license: anyOf: - type: 'null' - - *70 + - *73 organization: anyOf: - type: 'null' @@ -97488,10 +98180,10 @@ webhooks: type: string enum: - enabled - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -97567,11 +98259,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: &582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: &585 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) @@ -97794,11 +98486,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: *582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: *585 sender: *4 required: - action @@ -97986,11 +98678,11 @@ webhooks: - everyone required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - rule: *582 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + rule: *585 sender: *4 required: - action @@ -98074,7 +98766,7 @@ webhooks: type: string enum: - completed - check_run: &584 + check_run: &587 title: CheckRun description: A check performed on the code of a given code change type: object @@ -98142,8 +98834,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *306 - repository: *105 + items: *309 + repository: *108 status: type: string enum: @@ -98187,7 +98879,7 @@ webhooks: - examples: - neutral - deployment: *583 + deployment: *586 details_url: type: string examples: @@ -98247,7 +98939,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *306 + items: *309 started_at: type: string format: date-time @@ -98285,9 +98977,9 @@ webhooks: - output - app - pull_requests - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -98680,10 +99372,10 @@ webhooks: type: string enum: - created - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -99079,10 +99771,10 @@ webhooks: type: string enum: - requested_action - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 requested_action: description: The action requested by the user. type: object @@ -99487,10 +100179,10 @@ webhooks: type: string enum: - rerequested - check_run: *584 - installation: *579 - organization: *580 - repository: *581 + check_run: *587 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - check_run @@ -100482,10 +101174,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -101170,10 +101862,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -101852,10 +102544,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -102162,20 +102854,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &585 + commit_oid: &588 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: *578 - installation: *579 - organization: *580 - ref: &586 + enterprise: *581 + installation: *582 + organization: *583 + ref: &589 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: *581 + repository: *584 sender: *4 required: - action @@ -102503,12 +103195,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -102606,7 +103298,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *321 + dismissed_comment: *324 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -102781,12 +103473,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103118,12 +103810,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103392,9 +104084,9 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -103402,7 +104094,7 @@ webhooks: type: - string - 'null' - repository: *581 + repository: *584 sender: *4 required: - action @@ -103634,12 +104326,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *585 - enterprise: *578 - installation: *579 - organization: *580 - ref: *586 - repository: *581 + commit_oid: *588 + enterprise: *581 + installation: *582 + organization: *583 + ref: *589 + repository: *584 sender: *4 required: - action @@ -103901,10 +104593,10 @@ webhooks: - updated_at - author_association - body - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -103985,18 +104677,18 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *580 - pusher_type: &587 + organization: *583 + pusher_type: &590 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &588 + ref: &591 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -104006,7 +104698,7 @@ webhooks: enum: - tag - branch - repository: *581 + repository: *584 sender: *4 required: - ref @@ -104088,10 +104780,10 @@ webhooks: type: string enum: - created - definition: *188 - enterprise: *578 - installation: *579 - organization: *580 + definition: *191 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104175,9 +104867,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104253,10 +104945,10 @@ webhooks: type: string enum: - updated - definition: *188 - enterprise: *578 - installation: *579 - organization: *580 + definition: *191 + enterprise: *581 + installation: *582 + organization: *583 sender: *4 required: - action @@ -104332,19 +105024,19 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - repository: *581 - organization: *580 + enterprise: *581 + installation: *582 + repository: *584 + organization: *583 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *192 + items: *195 old_property_values: type: array description: The old custom property values for the repository. - items: *192 + items: *195 required: - action - repository @@ -104420,18 +105112,18 @@ webhooks: title: delete event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - pusher_type: *587 - ref: *588 + enterprise: *581 + installation: *582 + organization: *583 + pusher_type: *590 + ref: *591 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *581 + repository: *584 sender: *4 required: - ref @@ -104515,11 +105207,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104603,11 +105295,11 @@ webhooks: type: string enum: - auto_reopened - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104691,11 +105383,11 @@ webhooks: type: string enum: - created - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104777,11 +105469,11 @@ webhooks: type: string enum: - dismissed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104863,11 +105555,11 @@ webhooks: type: string enum: - fixed - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -104950,11 +105642,11 @@ webhooks: type: string enum: - reintroduced - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -105036,11 +105728,11 @@ webhooks: type: string enum: - reopened - alert: *370 - installation: *579 - organization: *580 - enterprise: *578 - repository: *581 + alert: *373 + installation: *582 + organization: *583 + enterprise: *581 + repository: *584 sender: *4 required: - action @@ -105117,9 +105809,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - key: &589 + enterprise: *581 + installation: *582 + key: &592 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -105155,8 +105847,8 @@ webhooks: - verified - created_at - read_only - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -105233,11 +105925,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - key: *589 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + key: *592 + organization: *583 + repository: *584 sender: *4 required: - action @@ -105809,12 +106501,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: &593 + workflow: &596 title: Workflow type: - object @@ -106552,13 +107244,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *376 + deployment: *379 pull_requests: type: array - items: *457 - repository: *581 - organization: *580 - installation: *579 + items: *460 + repository: *584 + organization: *583 + installation: *582 sender: *4 responses: '200': @@ -106629,7 +107321,7 @@ webhooks: type: string enum: - approved - approver: &590 + approver: &593 type: object properties: avatar_url: @@ -106672,11 +107364,11 @@ webhooks: type: string comment: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - reviewers: &591 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + reviewers: &594 type: array items: type: object @@ -106757,7 +107449,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &592 + workflow_job_run: &595 type: object properties: conclusion: @@ -107503,18 +108195,18 @@ webhooks: type: string enum: - rejected - approver: *590 + approver: *593 comment: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - reviewers: *591 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + reviewers: *594 sender: *4 since: type: string - workflow_job_run: *592 + workflow_job_run: *595 workflow_job_runs: type: array items: @@ -108231,13 +108923,13 @@ webhooks: type: string enum: - requested - enterprise: *578 + enterprise: *581 environment: type: string - installation: *579 - organization: *580 - repository: *581 - requestor: &598 + installation: *582 + organization: *583 + repository: *584 + requestor: &601 title: User type: - object @@ -110180,12 +110872,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Deployment Workflow Run type: @@ -110876,7 +111568,7 @@ webhooks: type: string enum: - answered - answer: &596 + answer: &599 type: object properties: author_association: @@ -111036,7 +111728,7 @@ webhooks: - created_at - updated_at - body - discussion: &594 + discussion: &597 title: Discussion description: A Discussion in a repository. type: object @@ -111332,7 +112024,7 @@ webhooks: - id labels: type: array - items: *421 + items: *424 required: - repository_url - category @@ -111354,10 +112046,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111484,11 +112176,11 @@ webhooks: - from required: - category - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111571,11 +112263,11 @@ webhooks: type: string enum: - closed - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111657,7 +112349,7 @@ webhooks: type: string enum: - created - comment: &595 + comment: &598 type: object properties: author_association: @@ -111817,11 +112509,11 @@ webhooks: - updated_at - body - reactions - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -111904,12 +112596,12 @@ webhooks: type: string enum: - deleted - comment: *595 - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + comment: *598 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112004,12 +112696,12 @@ webhooks: - from required: - body - comment: *595 - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + comment: *598 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112093,11 +112785,11 @@ webhooks: type: string enum: - created - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112179,11 +112871,11 @@ webhooks: type: string enum: - deleted - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112283,11 +112975,11 @@ webhooks: type: string required: - from - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112369,10 +113061,10 @@ webhooks: type: string enum: - labeled - discussion: *594 - enterprise: *578 - installation: *579 - label: &597 + discussion: *597 + enterprise: *581 + installation: *582 + label: &600 title: Label type: object properties: @@ -112405,8 +113097,8 @@ webhooks: - color - default - description - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112489,11 +113181,11 @@ webhooks: type: string enum: - locked - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112575,11 +113267,11 @@ webhooks: type: string enum: - pinned - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112661,11 +113353,11 @@ webhooks: type: string enum: - reopened - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112750,16 +113442,16 @@ webhooks: changes: type: object properties: - new_discussion: *594 - new_repository: *581 + new_discussion: *597 + new_repository: *584 required: - new_discussion - new_repository - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112842,10 +113534,10 @@ webhooks: type: string enum: - unanswered - discussion: *594 - old_answer: *596 - organization: *580 - repository: *581 + discussion: *597 + old_answer: *599 + organization: *583 + repository: *584 sender: *4 required: - action @@ -112927,12 +113619,12 @@ webhooks: type: string enum: - unlabeled - discussion: *594 - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113015,11 +113707,11 @@ webhooks: type: string enum: - unlocked - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113101,11 +113793,11 @@ webhooks: type: string enum: - unpinned - discussion: *594 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + discussion: *597 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -113178,7 +113870,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *578 + enterprise: *581 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -113856,9 +114548,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - forkee @@ -114004,9 +114696,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pages: description: The pages that were updated. type: array @@ -114044,7 +114736,7 @@ webhooks: - action - sha - html_url - repository: *581 + repository: *584 sender: *4 required: - pages @@ -114120,10 +114812,10 @@ webhooks: type: string enum: - created - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: &599 + organization: *583 + repositories: &602 description: An array of repository objects that the installation can access. type: array @@ -114149,8 +114841,8 @@ webhooks: - name - full_name - private - repository: *581 - requester: *598 + repository: *584 + requester: *601 sender: *4 required: - action @@ -114225,11 +114917,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114306,11 +114998,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114387,10 +115079,10 @@ webhooks: type: string enum: - added - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories_added: &600 + organization: *583 + repositories_added: &603 description: An array of repository objects, which were added to the installation. type: array @@ -114436,15 +115128,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *581 - repository_selection: &601 + repository: *584 + repository_selection: &604 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *598 + requester: *601 sender: *4 required: - action @@ -114523,10 +115215,10 @@ webhooks: type: string enum: - removed - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories_added: *600 + organization: *583 + repositories_added: *603 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -114553,9 +115245,9 @@ webhooks: - name - full_name - private - repository: *581 - repository_selection: *601 - requester: *598 + repository: *584 + repository_selection: *604 + requester: *601 sender: *4 required: - action @@ -114634,11 +115326,11 @@ webhooks: type: string enum: - suspend - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -114820,10 +115512,10 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 target_type: type: string @@ -114902,11 +115594,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *578 + enterprise: *581 installation: *20 - organization: *580 - repositories: *599 - repository: *581 + organization: *583 + repositories: *602 + repository: *584 requester: type: - 'null' @@ -115154,8 +115846,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -116331,8 +117023,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -116412,7 +117104,7 @@ webhooks: type: string enum: - deleted - comment: &602 + comment: &605 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -116579,8 +117271,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -117754,8 +118446,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -117835,7 +118527,7 @@ webhooks: type: string enum: - edited - changes: &627 + changes: &630 description: The changes to the comment. type: object properties: @@ -117847,9 +118539,9 @@ webhooks: type: string required: - from - comment: *602 - enterprise: *578 - installation: *579 + comment: *605 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119024,8 +119716,8 @@ webhooks: - state - locked - assignee - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -119107,10 +119799,10 @@ webhooks: type: string enum: - assigned - assignee: *598 - enterprise: *578 - installation: *579 - issue: &605 + assignee: *601 + enterprise: *581 + installation: *582 + issue: &608 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -120040,8 +120732,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -120121,8 +120813,8 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -121200,8 +121892,8 @@ webhooks: required: - state - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -121280,8 +121972,8 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122204,8 +122896,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -122284,8 +122976,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123212,7 +123904,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &603 + milestone: &606 title: Milestone description: A collection of related issues and pull requests. type: object @@ -123355,8 +124047,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -123455,8 +124147,8 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124386,9 +125078,9 @@ webhooks: - active_lock_reason - body - reactions - label: *597 - organization: *580 - repository: *581 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -124468,8 +125160,8 @@ webhooks: type: string enum: - labeled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125398,9 +126090,9 @@ webhooks: - active_lock_reason - body - reactions - label: *597 - organization: *580 - repository: *581 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -125480,8 +126172,8 @@ webhooks: type: string enum: - locked - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126412,8 +127104,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -126492,8 +127184,8 @@ webhooks: type: string enum: - milestoned - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127418,9 +128110,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *603 - organization: *580 - repository: *581 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -128906,8 +129598,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129836,8 +130528,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -129917,9 +130609,9 @@ webhooks: type: string enum: - pinned - enterprise: *578 - installation: *579 - issue: &604 + enterprise: *581 + installation: *582 + issue: &607 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -130842,8 +131534,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -130922,8 +131614,8 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131853,8 +132545,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133340,11 +134032,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *578 - installation: *579 - issue: *604 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *607 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133425,7 +134117,7 @@ webhooks: type: string enum: - unassigned - assignee: &630 + assignee: &633 title: User type: - object @@ -133497,11 +134189,11 @@ webhooks: required: - login - id - enterprise: *578 - installation: *579 - issue: *605 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *608 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133580,12 +134272,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *578 - installation: *579 - issue: *605 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *608 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -133665,8 +134357,8 @@ webhooks: type: string enum: - unlocked - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134595,8 +135287,8 @@ webhooks: format: uri user_view_type: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134676,11 +135368,11 @@ webhooks: type: string enum: - unpinned - enterprise: *578 - installation: *579 - issue: *604 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + issue: *607 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134759,11 +135451,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134841,11 +135533,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -134955,11 +135647,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - label: *597 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + label: *600 + organization: *583 + repository: *584 sender: *4 required: - action @@ -135041,9 +135733,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: &606 + enterprise: *581 + installation: *582 + marketplace_purchase: &609 title: Marketplace Purchase type: object required: @@ -135131,8 +135823,8 @@ webhooks: type: integer unit_count: type: integer - organization: *580 - previous_marketplace_purchase: &607 + organization: *583 + previous_marketplace_purchase: &610 title: Marketplace Purchase type: object properties: @@ -135216,7 +135908,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135296,10 +135988,10 @@ webhooks: - changed effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -135387,7 +136079,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135469,10 +136161,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -135558,7 +136250,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *581 + repository: *584 sender: *4 required: - action @@ -135639,8 +136331,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 marketplace_purchase: title: Marketplace Purchase type: object @@ -135726,9 +136418,9 @@ webhooks: type: integer unit_count: type: integer - organization: *580 - previous_marketplace_purchase: *607 - repository: *581 + organization: *583 + previous_marketplace_purchase: *610 + repository: *584 sender: *4 required: - action @@ -135808,12 +136500,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *578 - installation: *579 - marketplace_purchase: *606 - organization: *580 - previous_marketplace_purchase: *607 - repository: *581 + enterprise: *581 + installation: *582 + marketplace_purchase: *609 + organization: *583 + previous_marketplace_purchase: *610 + repository: *584 sender: *4 required: - action @@ -135915,11 +136607,11 @@ webhooks: type: string required: - to - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136021,11 +136713,11 @@ webhooks: type: - string - 'null' - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136104,11 +136796,11 @@ webhooks: type: string enum: - removed - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136186,11 +136878,11 @@ webhooks: type: string enum: - added - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 scope: description: The scope of the membership. Currently, can only be `team`. @@ -136268,7 +136960,7 @@ webhooks: required: - login - id - team: &608 + team: &611 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -136461,11 +137153,11 @@ webhooks: type: string enum: - removed - enterprise: *578 - installation: *579 - member: *598 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + member: *601 + organization: *583 + repository: *584 scope: description: The scope of the membership. Currently, can only be `team`. @@ -136544,7 +137236,7 @@ webhooks: required: - login - id - team: *608 + team: *611 required: - action - scope @@ -136626,8 +137318,8 @@ webhooks: type: string enum: - checks_requested - installation: *579 - merge_group: &609 + installation: *582 + merge_group: &612 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -136646,15 +137338,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *310 + head_commit: *313 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136740,10 +137432,10 @@ webhooks: - merged - invalidated - dequeued - installation: *579 - merge_group: *609 - organization: *580 - repository: *581 + installation: *582 + merge_group: *612 + organization: *583 + repository: *584 sender: *4 required: - action @@ -136816,7 +137508,7 @@ webhooks: type: string enum: - deleted - enterprise: *578 + enterprise: *581 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -136924,12 +137616,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *579 - organization: *580 + installation: *582 + organization: *583 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -137009,11 +137701,11 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137092,9 +137784,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - milestone: &610 + enterprise: *581 + installation: *582 + milestone: &613 title: Milestone description: A collection of related issues and pull requests. type: object @@ -137236,8 +137928,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137316,11 +138008,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137430,11 +138122,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - milestone: *603 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *606 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137514,11 +138206,11 @@ webhooks: type: string enum: - opened - enterprise: *578 - installation: *579 - milestone: *610 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + milestone: *613 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137597,11 +138289,11 @@ webhooks: type: string enum: - blocked - blocked_user: *598 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + blocked_user: *601 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137680,11 +138372,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *598 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + blocked_user: *601 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137763,9 +138455,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - membership: &611 + enterprise: *581 + installation: *582 + membership: &614 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -137859,8 +138551,8 @@ webhooks: - role - organization_url - user - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 required: - action @@ -137938,11 +138630,11 @@ webhooks: type: string enum: - member_added - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138021,8 +138713,8 @@ webhooks: type: string enum: - member_invited - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -138144,10 +138836,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 - user: *598 + user: *601 required: - action - invitation @@ -138225,11 +138917,11 @@ webhooks: type: string enum: - member_removed - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138316,11 +139008,11 @@ webhooks: properties: from: type: string - enterprise: *578 - installation: *579 - membership: *611 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + membership: *614 + organization: *583 + repository: *584 sender: *4 required: - action @@ -138396,9 +139088,9 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 package: description: Information about the package. type: object @@ -138921,7 +139613,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &612 + items: &615 title: Ruby Gems metadata type: object properties: @@ -139018,7 +139710,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -139094,9 +139786,9 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 package: description: Information about the package. type: object @@ -139458,7 +140150,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *612 + items: *615 source_url: type: string format: uri @@ -139529,7 +140221,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -139710,12 +140402,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *578 + enterprise: *581 id: type: integer - installation: *579 - organization: *580 - repository: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - id @@ -139795,7 +140487,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &613 + personal_access_token_request: &616 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -139933,10 +140625,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *578 - organization: *580 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140015,11 +140707,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *613 - enterprise: *578 - organization: *580 + personal_access_token_request: *616 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140097,11 +140789,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *613 - enterprise: *578 - organization: *580 + personal_access_token_request: *616 + enterprise: *581 + organization: *583 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140178,11 +140870,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *613 - organization: *580 - enterprise: *578 + personal_access_token_request: *616 + organization: *583 + enterprise: *581 sender: *4 - installation: *579 + installation: *582 required: - action - personal_access_token_request @@ -140286,7 +140978,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *614 + last_response: *617 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -140318,8 +141010,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 zen: description: Random string of GitHub zen. @@ -140564,10 +141256,10 @@ webhooks: - from required: - note - enterprise: *578 - installation: *579 - organization: *580 - project_card: &615 + enterprise: *581 + installation: *582 + organization: *583 + project_card: &618 title: Project Card type: object properties: @@ -140690,7 +141382,7 @@ webhooks: - creator - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -140771,11 +141463,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project_card: *615 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_card: *618 + repository: *584 sender: *4 required: - action @@ -140855,9 +141547,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 project_card: title: Project Card type: object @@ -140987,7 +141679,7 @@ webhooks: repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -141081,11 +141773,11 @@ webhooks: - from required: - note - enterprise: *578 - installation: *579 - organization: *580 - project_card: *615 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_card: *618 + repository: *584 sender: *4 required: - action @@ -141179,9 +141871,9 @@ webhooks: - from required: - column_id - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 project_card: allOf: - title: Project Card @@ -141378,7 +142070,7 @@ webhooks: type: string required: - after_id - repository: *581 + repository: *584 sender: *4 required: - action @@ -141458,10 +142150,10 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - organization: *580 - project: &617 + enterprise: *581 + installation: *582 + organization: *583 + project: &620 title: Project type: object properties: @@ -141588,7 +142280,7 @@ webhooks: - creator - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -141668,10 +142360,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project_column: &616 + enterprise: *581 + installation: *582 + organization: *583 + project_column: &619 title: Project Column type: object properties: @@ -141711,7 +142403,7 @@ webhooks: - name - created_at - updated_at - repository: *581 + repository: *584 sender: *4 required: - action @@ -141790,14 +142482,14 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -141886,11 +142578,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 + repository: *584 sender: *4 required: - action @@ -141970,11 +142662,11 @@ webhooks: type: string enum: - moved - enterprise: *578 - installation: *579 - organization: *580 - project_column: *616 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project_column: *619 + repository: *584 sender: *4 required: - action @@ -142054,11 +142746,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142138,14 +142830,14 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - project: *617 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 repository: anyOf: - type: 'null' - - *581 + - *584 sender: *4 required: - action @@ -142246,11 +142938,11 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142329,11 +143021,11 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 - organization: *580 - project: *617 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + project: *620 + repository: *584 sender: *4 required: - action @@ -142414,9 +143106,9 @@ webhooks: type: string enum: - closed - installation: *579 - organization: *580 - projects_v2: &618 + installation: *582 + organization: *583 + projects_v2: &621 title: Projects v2 Project description: A projects v2 project type: object @@ -142564,9 +143256,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142647,9 +143339,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142770,9 +143462,9 @@ webhooks: type: string to: type: string - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -142855,7 +143547,7 @@ webhooks: type: string enum: - archived - changes: &622 + changes: &625 type: object properties: archived_at: @@ -142871,9 +143563,9 @@ webhooks: - string - 'null' format: date-time - installation: *579 - organization: *580 - projects_v2_item: &619 + installation: *582 + organization: *583 + projects_v2_item: &622 title: Projects v2 Item description: An item belonging to a project type: object @@ -143012,9 +143704,9 @@ webhooks: - 'null' to: type: string - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143096,9 +143788,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143179,9 +143871,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143286,7 +143978,7 @@ webhooks: oneOf: - type: string - type: integer - - &620 + - &623 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -143306,7 +143998,7 @@ webhooks: required: - id - name - - &621 + - &624 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -143335,8 +144027,8 @@ webhooks: oneOf: - type: string - type: integer - - *620 - - *621 + - *623 + - *624 type: - 'null' - string @@ -143359,9 +144051,9 @@ webhooks: - 'null' required: - body - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143458,9 +144150,9 @@ webhooks: type: - string - 'null' - installation: *579 - organization: *580 - projects_v2_item: *619 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143543,10 +144235,10 @@ webhooks: type: string enum: - restored - changes: *622 - installation: *579 - organization: *580 - projects_v2_item: *619 + changes: *625 + installation: *582 + organization: *583 + projects_v2_item: *622 sender: *4 required: - action @@ -143628,9 +144320,9 @@ webhooks: type: string enum: - reopened - installation: *579 - organization: *580 - projects_v2: *618 + installation: *582 + organization: *583 + projects_v2: *621 sender: *4 required: - action @@ -143711,9 +144403,9 @@ webhooks: type: string enum: - created - installation: *579 - organization: *580 - projects_v2_status_update: &623 + installation: *582 + organization: *583 + projects_v2_status_update: &626 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -143848,9 +144540,9 @@ webhooks: type: string enum: - deleted - installation: *579 - organization: *580 - projects_v2_status_update: *623 + installation: *582 + organization: *583 + projects_v2_status_update: *626 sender: *4 required: - action @@ -143996,9 +144688,9 @@ webhooks: - string - 'null' format: date - installation: *579 - organization: *580 - projects_v2_status_update: *623 + installation: *582 + organization: *583 + projects_v2_status_update: *626 sender: *4 required: - action @@ -144069,10 +144761,10 @@ webhooks: title: public event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - repository @@ -144149,13 +144841,13 @@ webhooks: type: string enum: - assigned - assignee: *598 - enterprise: *578 - installation: *579 - number: &624 + assignee: *601 + enterprise: *581 + installation: *582 + number: &627 description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -146504,7 +147196,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -146586,11 +147278,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -148932,7 +149624,7 @@ webhooks: - draft reason: type: string - repository: *581 + repository: *584 sender: *4 required: - action @@ -149014,11 +149706,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -151360,7 +152052,7 @@ webhooks: - draft reason: type: string - repository: *581 + repository: *584 sender: *4 required: - action @@ -151442,13 +152134,13 @@ webhooks: type: string enum: - closed - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: &625 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: &628 allOf: - - *457 + - *460 - type: object properties: allow_auto_merge: @@ -151510,7 +152202,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *581 + repository: *584 sender: *4 required: - action @@ -151591,12 +152283,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -151676,11 +152368,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *578 - milestone: *356 - number: *624 - organization: *580 - pull_request: &626 + enterprise: *581 + milestone: *359 + number: *627 + organization: *583 + pull_request: &629 title: Pull Request type: object properties: @@ -154007,7 +154699,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -154086,11 +154778,11 @@ webhooks: type: string enum: - dequeued - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -156436,7 +157128,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *581 + repository: *584 sender: *4 required: - action @@ -156560,12 +157252,12 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -156645,11 +157337,11 @@ webhooks: type: string enum: - enqueued - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -158980,7 +159672,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -159060,11 +159752,11 @@ webhooks: type: string enum: - labeled - enterprise: *578 - installation: *579 - label: *597 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + label: *600 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -161412,7 +162104,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -161493,10 +162185,10 @@ webhooks: type: string enum: - locked - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -163842,7 +164534,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -163922,12 +164614,12 @@ webhooks: type: string enum: - milestoned - enterprise: *578 - milestone: *356 - number: *624 - organization: *580 - pull_request: *626 - repository: *581 + enterprise: *581 + milestone: *359 + number: *627 + organization: *583 + pull_request: *629 + repository: *584 sender: *4 required: - action @@ -164006,12 +164698,12 @@ webhooks: type: string enum: - opened - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164092,12 +164784,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164177,12 +164869,12 @@ webhooks: type: string enum: - reopened - enterprise: *578 - installation: *579 - number: *624 - organization: *580 - pull_request: *625 - repository: *581 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 + pull_request: *628 + repository: *584 sender: *4 required: - action @@ -164557,9 +165249,9 @@ webhooks: - start_side - side - reactions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -166789,7 +167481,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -166869,7 +167561,7 @@ webhooks: type: string enum: - deleted - comment: &628 + comment: &631 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -167162,9 +167854,9 @@ webhooks: - start_side - side - reactions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -169382,7 +170074,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -169462,11 +170154,11 @@ webhooks: type: string enum: - edited - changes: *627 - comment: *628 - enterprise: *578 - installation: *579 - organization: *580 + changes: *630 + comment: *631 + enterprise: *581 + installation: *582 + organization: *583 pull_request: type: object properties: @@ -171687,7 +172379,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *581 + repository: *584 sender: *4 required: - action @@ -171768,9 +172460,9 @@ webhooks: type: string enum: - dismissed - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -174003,7 +174695,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 review: description: The review that was affected. type: object @@ -174249,9 +174941,9 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -176365,8 +177057,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 - review: &629 + repository: *584 + review: &632 description: The review that was affected. type: object properties: @@ -176599,12 +177291,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -178951,7 +179643,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_reviewer: title: User type: @@ -179037,12 +179729,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -181396,7 +182088,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_team: title: Team description: Groups of organization members that gives permissions @@ -181591,12 +182283,12 @@ webhooks: type: string enum: - review_requested - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -183945,7 +184637,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_reviewer: title: User type: @@ -184032,12 +184724,12 @@ webhooks: type: string enum: - review_requested - enterprise: *578 - installation: *579 + enterprise: *581 + installation: *582 number: description: The pull request number. type: integer - organization: *580 + organization: *583 pull_request: title: Pull Request type: object @@ -186377,7 +187069,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 requested_team: title: Team description: Groups of organization members that gives permissions @@ -186561,9 +187253,9 @@ webhooks: type: string enum: - submitted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -188799,8 +189491,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 - review: *629 + repository: *584 + review: *632 sender: *4 required: - action @@ -188880,9 +189572,9 @@ webhooks: type: string enum: - resolved - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -191013,7 +191705,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 sender: *4 thread: type: object @@ -191405,9 +192097,9 @@ webhooks: type: string enum: - unresolved - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 pull_request: title: Simple Pull Request type: object @@ -193521,7 +194213,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *581 + repository: *584 sender: *4 thread: type: object @@ -193915,10 +194607,10 @@ webhooks: type: string before: type: string - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -196253,7 +196945,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -196335,11 +197027,11 @@ webhooks: type: string enum: - unassigned - assignee: *630 - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + assignee: *633 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -198689,7 +199381,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -198768,11 +199460,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *578 - installation: *579 - label: *597 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + label: *600 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -201111,7 +201803,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -201192,10 +201884,10 @@ webhooks: type: string enum: - unlocked - enterprise: *578 - installation: *579 - number: *624 - organization: *580 + enterprise: *581 + installation: *582 + number: *627 + organization: *583 pull_request: title: Pull Request type: object @@ -203524,7 +204216,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *581 + repository: *584 sender: *4 required: - action @@ -203727,7 +204419,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *578 + enterprise: *581 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -203822,8 +204514,8 @@ webhooks: - url - author - committer - installation: *579 - organization: *580 + installation: *582 + organization: *583 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -204411,9 +205103,9 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 registry_package: type: object properties: @@ -204890,7 +205582,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *612 + items: *615 summary: type: string tag_name: @@ -204946,7 +205638,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -205024,9 +205716,9 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 registry_package: type: object properties: @@ -205338,7 +206030,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *612 + items: *615 summary: type: string tag_name: @@ -205388,7 +206080,7 @@ webhooks: - owner - package_version - registry - repository: *581 + repository: *584 sender: *4 required: - action @@ -205465,10 +206157,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - release: &631 + enterprise: *581 + installation: *582 + organization: *583 + release: &634 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -205784,7 +206476,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *581 + repository: *584 sender: *4 required: - action @@ -205861,11 +206553,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -205973,11 +206665,11 @@ webhooks: type: boolean required: - to - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -206055,9 +206747,9 @@ webhooks: type: string enum: - prereleased - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -206378,7 +207070,7 @@ webhooks: - string - 'null' format: uri - repository: *581 + repository: *584 sender: *4 required: - action @@ -206454,10 +207146,10 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - release: &632 + enterprise: *581 + installation: *582 + organization: *583 + release: &635 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -206775,7 +207467,7 @@ webhooks: - string - 'null' format: uri - repository: *581 + repository: *584 sender: *4 required: - action @@ -206851,11 +207543,11 @@ webhooks: type: string enum: - released - enterprise: *578 - installation: *579 - organization: *580 - release: *631 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *634 + repository: *584 sender: *4 required: - action @@ -206931,11 +207623,11 @@ webhooks: type: string enum: - unpublished - enterprise: *578 - installation: *579 - organization: *580 - release: *632 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + release: *635 + repository: *584 sender: *4 required: - action @@ -207011,11 +207703,11 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_advisory: *510 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_advisory: *513 sender: *4 required: - action @@ -207091,11 +207783,11 @@ webhooks: type: string enum: - reported - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_advisory: *510 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_advisory: *513 sender: *4 required: - action @@ -207171,10 +207863,10 @@ webhooks: type: string enum: - archived - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207251,10 +207943,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207332,10 +208024,10 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207420,10 +208112,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207538,10 +208230,10 @@ webhooks: - 'null' items: type: string - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207613,10 +208305,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 status: type: string @@ -207697,10 +208389,10 @@ webhooks: type: string enum: - privatized - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207777,10 +208469,10 @@ webhooks: type: string enum: - publicized - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207874,10 +208566,10 @@ webhooks: - name required: - repository - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -207957,11 +208649,11 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 sender: *4 required: - action @@ -208039,11 +208731,11 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 sender: *4 required: - action @@ -208121,11 +208813,11 @@ webhooks: type: string enum: - edited - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - repository_ruleset: *200 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + repository_ruleset: *203 changes: type: object properties: @@ -208144,16 +208836,16 @@ webhooks: properties: added: type: array - items: *194 + items: *197 deleted: type: array - items: *194 + items: *197 updated: type: array items: type: object properties: - condition: *194 + condition: *197 changes: type: object properties: @@ -208186,16 +208878,16 @@ webhooks: properties: added: type: array - items: *199 + items: *202 deleted: type: array - items: *199 + items: *202 updated: type: array items: type: object properties: - rule: *199 + rule: *202 changes: type: object properties: @@ -208432,10 +209124,10 @@ webhooks: - from required: - owner - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208513,10 +209205,10 @@ webhooks: type: string enum: - unarchived - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208594,7 +209286,7 @@ webhooks: type: string enum: - create - alert: &633 + alert: &636 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -208718,10 +209410,10 @@ webhooks: type: string enum: - open - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -208931,10 +209623,10 @@ webhooks: type: string enum: - dismissed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209012,11 +209704,11 @@ webhooks: type: string enum: - reopen - alert: *633 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209218,10 +209910,10 @@ webhooks: enum: - fixed - open - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209299,7 +209991,7 @@ webhooks: type: string enum: - created - alert: &634 + alert: &637 type: object properties: number: *46 @@ -209387,10 +210079,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209471,11 +210163,11 @@ webhooks: type: string enum: - created - alert: *634 - installation: *579 - location: *635 - organization: *580 - repository: *581 + alert: *637 + installation: *582 + location: *638 + organization: *583 + repository: *584 sender: *4 required: - location @@ -209713,11 +210405,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209795,11 +210487,11 @@ webhooks: type: string enum: - reopened - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209877,11 +210569,11 @@ webhooks: type: string enum: - resolved - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -209959,11 +210651,11 @@ webhooks: type: string enum: - validated - alert: *634 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + alert: *637 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -210039,11 +210731,11 @@ webhooks: type: string enum: - published - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - security_advisory: &636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + security_advisory: &639 description: The details of the security advisory, including summary, description, and severity. type: object @@ -210229,11 +210921,11 @@ webhooks: type: string enum: - updated - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 - security_advisory: *636 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 + security_advisory: *639 sender: *4 required: - action @@ -210306,10 +210998,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -210495,11 +211187,11 @@ webhooks: from: type: object properties: - security_and_analysis: *193 - enterprise: *578 - installation: *579 - organization: *580 - repository: *238 + security_and_analysis: *196 + enterprise: *581 + installation: *582 + organization: *583 + repository: *241 sender: *4 required: - changes @@ -210577,12 +211269,12 @@ webhooks: type: string enum: - cancelled - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: &637 + sponsorship: &640 type: object properties: created_at: @@ -210887,12 +211579,12 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - sponsorship @@ -210980,12 +211672,12 @@ webhooks: type: string required: - from - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211062,17 +211754,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &638 + effective_date: &641 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: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - sponsorship @@ -211146,7 +211838,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &639 + changes: &642 type: object properties: tier: @@ -211190,13 +211882,13 @@ webhooks: - from required: - tier - effective_date: *638 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + effective_date: *641 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211273,13 +211965,13 @@ webhooks: type: string enum: - tier_changed - changes: *639 - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + changes: *642 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - sponsorship: *637 + sponsorship: *640 required: - action - changes @@ -211353,10 +212045,10 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -211440,10 +212132,10 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -211872,15 +212564,15 @@ webhooks: type: - string - 'null' - enterprise: *578 + enterprise: *581 id: description: The unique identifier of the status. type: integer - installation: *579 + installation: *582 name: type: string - organization: *580 - repository: *581 + organization: *583 + repository: *584 sender: *4 sha: description: The Commit SHA. @@ -211990,15 +212682,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - parent_issue_repo: *54 + parent_issue: *72 + parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - installation: *579 - organization: *580 - repository: *581 + sub_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212082,15 +212774,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - parent_issue_repo: *54 + parent_issue: *72 + parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - installation: *579 - organization: *580 - repository: *581 + sub_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212174,15 +212866,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - sub_issue_repo: *54 + sub_issue: *72 + sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - installation: *579 - organization: *580 - repository: *581 + parent_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212266,15 +212958,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *69 - sub_issue_repo: *54 + sub_issue: *72 + sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *69 - installation: *579 - organization: *580 - repository: *581 + parent_issue: *72 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -212351,12 +213043,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - team: &640 + team: &643 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -212549,9 +213241,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -213021,7 +213713,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -213097,9 +213789,9 @@ webhooks: type: string enum: - created - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -213569,7 +214261,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -213646,9 +214338,9 @@ webhooks: type: string enum: - deleted - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -214118,7 +214810,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -214262,9 +214954,9 @@ webhooks: - from required: - permissions - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -214734,7 +215426,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - changes @@ -214812,9 +215504,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *578 - installation: *579 - organization: *580 + enterprise: *581 + installation: *582 + organization: *583 repository: title: Repository description: A git repository @@ -215284,7 +215976,7 @@ webhooks: - topics - visibility sender: *4 - team: *640 + team: *643 required: - action - team @@ -215360,10 +216052,10 @@ webhooks: type: string enum: - started - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 required: - action @@ -215436,17 +216128,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *578 + enterprise: *581 inputs: type: - object - 'null' additionalProperties: true - installation: *579 - organization: *580 + installation: *582 + organization: *583 ref: type: string - repository: *581 + repository: *584 sender: *4 workflow: type: string @@ -215528,10 +216220,10 @@ webhooks: type: string enum: - completed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: allOf: @@ -215787,7 +216479,7 @@ webhooks: type: string required: - conclusion - deployment: *376 + deployment: *379 required: - action - repository @@ -215866,10 +216558,10 @@ webhooks: type: string enum: - in_progress - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: allOf: @@ -216151,7 +216843,7 @@ webhooks: required: - status - steps - deployment: *376 + deployment: *379 required: - action - repository @@ -216230,10 +216922,10 @@ webhooks: type: string enum: - queued - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: type: object @@ -216379,7 +217071,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *376 + deployment: *379 required: - action - repository @@ -216458,10 +217150,10 @@ webhooks: type: string enum: - waiting - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 workflow_job: type: object @@ -216608,7 +217300,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *376 + deployment: *379 required: - action - repository @@ -216688,12 +217380,12 @@ webhooks: type: string enum: - completed - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object @@ -217712,12 +218404,12 @@ webhooks: type: string enum: - in_progress - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object @@ -218721,12 +219413,12 @@ webhooks: type: string enum: - requested - enterprise: *578 - installation: *579 - organization: *580 - repository: *581 + enterprise: *581 + installation: *582 + organization: *583 + repository: *584 sender: *4 - workflow: *593 + workflow: *596 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 1493d193ea..a6656a4426 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -28034,6 +28034,662 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -33417,6 +34073,671 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -92388,6 +93709,662 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -161564,6 +163541,671 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index c4fbd997b0..e44bf6e204 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -896,7 +896,7 @@ paths: - subscriptions_url - type - url - type: &252 + type: &255 type: string description: The type of credit the user is receiving. enum: @@ -1029,7 +1029,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &118 + schema: &121 title: Validation Error Simple description: Validation Error Simple type: object @@ -1062,7 +1062,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: - - &553 + - &556 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1593,7 +1593,7 @@ paths: schema: type: integer default: 30 - - &187 + - &190 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 @@ -1614,7 +1614,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1707,7 +1707,7 @@ paths: - installation_id - repository_id examples: - default: &189 + default: &192 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1739,7 +1739,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &563 + schema: &566 title: Scim Error description: Scim Error type: object @@ -1770,7 +1770,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &117 + schema: &120 title: Validation Error description: Validation Error type: object @@ -1842,7 +1842,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &193 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1977,7 +1977,7 @@ paths: - request - response examples: - default: &191 + default: &194 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2037,7 +2037,7 @@ paths: parameters: - *16 responses: - '202': &120 + '202': &123 description: Accepted content: application/json: @@ -2246,7 +2246,7 @@ paths: parameters: - *17 - *18 - - &88 + - &91 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) @@ -3010,7 +3010,7 @@ paths: license: anyOf: - type: 'null' - - &99 + - &102 title: License Simple description: License Simple type: object @@ -7605,7 +7605,7 @@ paths: description: Response content: application/json: - schema: &121 + schema: &124 type: object properties: total_active_caches_count: @@ -7620,7 +7620,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &122 + default: &125 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7715,7 +7715,7 @@ paths: - all - local_only - selected - selected_actions_url: &125 + selected_actions_url: &128 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` @@ -8096,7 +8096,7 @@ paths: description: Success response content: application/json: - schema: &128 + schema: &131 type: object properties: default_workflow_permissions: &44 @@ -8144,7 +8144,7 @@ paths: required: true content: application/json: - schema: &129 + schema: &132 type: object properties: default_workflow_permissions: *44 @@ -8973,7 +8973,7 @@ paths: application/json: schema: type: array - items: &133 + items: &136 title: Runner Application description: Runner Application type: object @@ -8998,7 +8998,7 @@ paths: - download_url - filename examples: - default: &134 + default: &137 value: - os: osx architecture: x64 @@ -9082,7 +9082,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &135 + '201': &138 description: Response content: application/json: @@ -9196,7 +9196,7 @@ paths: - token - expires_at examples: - default: &136 + default: &139 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9236,7 +9236,7 @@ paths: application/json: schema: *56 examples: - default: &137 + default: &140 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9268,7 +9268,7 @@ paths: application/json: schema: *53 examples: - default: &138 + default: &141 value: id: 23 name: MBP @@ -9482,7 +9482,7 @@ paths: - *38 - *52 responses: - '200': &139 + '200': &142 description: Response content: application/json: @@ -9538,7 +9538,7 @@ paths: parameters: - *38 - *52 - - &140 + - &143 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9635,7 +9635,7 @@ paths: required: true content: application/json: - schema: &147 + schema: &150 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9706,7 +9706,7 @@ paths: required: false schema: type: string - - &148 + - &151 name: include description: |- The event types to include: @@ -9724,7 +9724,7 @@ paths: - web - git - all - - &149 + - &152 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. @@ -9732,7 +9732,7 @@ paths: required: false schema: type: string - - &150 + - &153 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. @@ -9740,7 +9740,7 @@ paths: required: false schema: type: string - - &151 + - &154 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9762,7 +9762,7 @@ paths: application/json: schema: type: array - items: &152 + items: &155 type: object properties: "@timestamp": @@ -9884,7 +9884,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &153 + default: &156 value: - "@timestamp": 1606929874512 action: team.add_member @@ -9930,7 +9930,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *38 - - &155 + - &158 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`, @@ -9940,7 +9940,7 @@ paths: schema: &66 type: string description: The name of the tool used to generate the code scanning analysis. - - &156 + - &159 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 @@ -9964,7 +9964,7 @@ paths: be returned. in: query required: false - schema: &157 + schema: &160 type: string description: State of a code scanning alert. enum: @@ -9989,7 +9989,7 @@ paths: application/json: schema: type: array - items: &158 + items: &161 type: object properties: number: &70 @@ -10018,7 +10018,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &360 + instances_url: &363 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10054,7 +10054,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &361 + dismissed_reason: &364 type: - string - 'null' @@ -10065,14 +10065,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &362 + dismissed_comment: &365 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &363 + rule: &366 type: object properties: id: @@ -10133,7 +10133,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &364 + tool: &367 type: object properties: name: *66 @@ -10144,15 +10144,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *67 - most_recent_instance: &365 + most_recent_instance: &368 type: object properties: - ref: &358 + ref: &361 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &371 + analysis_key: &374 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10163,7 +10163,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &372 + category: &375 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10547,7 +10547,7 @@ paths: - most_recent_instance - repository examples: - default: &159 + default: &162 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -11202,7 +11202,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &165 + items: &168 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11217,7 +11217,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &198 + - &201 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11276,7 +11276,7 @@ paths: parent: anyOf: - type: 'null' - - &211 + - &214 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -11470,7 +11470,7 @@ paths: - created_at additionalProperties: false examples: - default: &166 + default: &169 value: total_seats: 2 seats: @@ -11552,6 +11552,487 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - *38 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &83 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true + examples: + default: &84 + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + '500': *69 + '403': *27 + '404': *6 + '422': &85 + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: *3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -11609,7 +12090,7 @@ paths: application/json: schema: type: array - items: &83 + items: &86 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -11789,7 +12270,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &173 + - &176 name: state in: query description: |- @@ -11798,7 +12279,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &174 + - &177 name: severity in: query description: |- @@ -11807,7 +12288,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &175 + - &178 name: ecosystem in: query description: |- @@ -11816,14 +12297,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &176 + - &179 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &177 + - &180 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -11833,7 +12314,7 @@ paths: enum: - development - runtime - - &178 + - &181 name: sort in: query description: |- @@ -11849,7 +12330,7 @@ paths: - *65 - *63 - *64 - - &179 + - &182 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -11862,7 +12343,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &180 + - &183 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -11882,7 +12363,7 @@ paths: application/json: schema: type: array - items: &181 + items: &184 type: object description: A Dependabot alert. properties: @@ -11934,7 +12415,7 @@ paths: - development - runtime - - security_advisory: &409 + security_advisory: &412 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12169,7 +12650,7 @@ paths: dismissal. maxLength: 280 fixed_at: *79 - auto_dismissed_at: &410 + auto_dismissed_at: &413 type: - string - 'null' @@ -12196,7 +12677,7 @@ paths: - repository additionalProperties: false examples: - default: &182 + default: &185 value: - number: 2 state: dismissed @@ -12602,7 +13083,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &243 + - &246 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -12613,7 +13094,7 @@ paths: enum: - open - resolved - - &244 + - &247 name: secret_type in: query description: |- @@ -12623,7 +13104,7 @@ paths: required: false schema: type: string - - &245 + - &248 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -12632,7 +13113,7 @@ paths: required: false schema: type: string - - &246 + - &249 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. @@ -12648,7 +13129,7 @@ paths: - *17 - *63 - *64 - - &247 + - &250 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -12657,7 +13138,7 @@ paths: required: false schema: type: string - - &248 + - &251 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -12666,7 +13147,7 @@ paths: schema: type: boolean default: false - - &249 + - &252 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -12682,7 +13163,7 @@ paths: application/json: schema: type: array - items: &250 + items: &253 type: object properties: number: *70 @@ -12698,14 +13179,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &546 + state: &549 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: &547 + resolution: &550 type: - string - 'null' @@ -12782,7 +13263,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &251 + default: &254 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -13019,7 +13500,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &256 type: object properties: total_minutes_used: @@ -13089,7 +13570,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &254 + default: &257 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -13127,7 +13608,7 @@ paths: description: Success content: application/json: - schema: &255 + schema: &258 type: object properties: total_advanced_security_committers: @@ -13190,7 +13671,7 @@ paths: required: - repositories examples: - default: &256 + default: &259 value: total_advanced_security_committers: 2 total_count: 2 @@ -13341,7 +13822,7 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *27 - '409': &119 + '409': &122 description: Conflict content: application/json: @@ -13433,7 +13914,7 @@ paths: description: Response content: application/json: - schema: &257 + schema: &260 type: object properties: total_gigabytes_bandwidth_used: @@ -13451,7 +13932,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &258 + default: &261 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -13483,7 +13964,7 @@ paths: description: Response content: application/json: - schema: &259 + schema: &262 type: object properties: days_left_in_billing_cycle: @@ -13501,7 +13982,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &260 + default: &263 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -13642,6 +14123,80 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - *38 + - name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -13671,7 +14226,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &210 + - &213 name: team_slug description: The slug of the team name. in: path @@ -13709,9 +14264,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: &167 + default: &170 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -13867,7 +14422,7 @@ paths: application/json: schema: type: array - items: &109 + items: &112 title: Event description: Event type: object @@ -13878,7 +14433,7 @@ paths: type: - string - 'null' - actor: &84 + actor: &87 title: Actor description: Actor type: object @@ -13919,13 +14474,13 @@ paths: - id - name - url - org: *84 + org: *87 payload: type: object properties: action: type: string - issue: &98 + issue: &101 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -14045,7 +14600,7 @@ paths: milestone: anyOf: - type: 'null' - - &397 + - &400 title: Milestone description: A collection of related issues and pull requests. @@ -14222,7 +14777,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &85 + author_association: &88 title: author_association type: string description: How the author is associated with the repository. @@ -14237,7 +14792,7 @@ paths: - OWNER examples: - OWNER - reactions: &86 + reactions: &89 title: Reaction Rollup type: object properties: @@ -14295,7 +14850,7 @@ paths: - author_association - created_at - updated_at - comment: &456 + comment: &459 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -14345,12 +14900,12 @@ paths: issue_url: type: string format: uri - author_association: *85 + author_association: *88 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - id - node_id @@ -14537,7 +15092,7 @@ paths: _links: type: object properties: - timeline: &87 + timeline: &90 title: Link With Type description: Hypermedia Link with Type type: object @@ -14549,17 +15104,17 @@ paths: required: - href - type - user: *87 - security_advisories: *87 - current_user: *87 - current_user_public: *87 - current_user_actor: *87 - current_user_organization: *87 + user: *90 + security_advisories: *90 + current_user: *90 + current_user_public: *90 + current_user_actor: *90 + current_user_organization: *90 current_user_organizations: type: array - items: *87 - repository_discussions: *87 - repository_discussions_category: *87 + items: *90 + repository_discussions: *90 + repository_discussions_category: *90 required: - timeline - user @@ -14621,7 +15176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *88 + - *91 - *17 - *18 responses: @@ -14631,7 +15186,7 @@ paths: application/json: schema: type: array - items: &89 + items: &92 title: Base Gist description: Base Gist type: object @@ -14721,7 +15276,7 @@ paths: - created_at - updated_at examples: - default: &90 + default: &93 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -14845,7 +15400,7 @@ paths: description: Response content: application/json: - schema: &91 + schema: &94 title: Gist Simple description: Gist Simple type: object @@ -14863,7 +15418,7 @@ paths: url: type: string format: uri - user: &602 + user: &605 title: Public User description: Public User type: object @@ -15228,7 +15783,7 @@ paths: truncated: type: boolean examples: - default: &92 + default: &95 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -15330,7 +15885,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *88 + - *91 - *17 - *18 responses: @@ -15340,9 +15895,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '422': *15 @@ -15364,7 +15919,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *88 + - *91 - *17 - *18 responses: @@ -15374,9 +15929,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '401': *23 @@ -15404,7 +15959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &93 + - &96 name: gist_id description: The unique identifier of the gist. in: path @@ -15416,10 +15971,10 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - default: *92 - '403': &96 + default: *95 + '403': &99 description: Forbidden Gist content: application/json: @@ -15468,7 +16023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *93 + - *96 requestBody: required: true content: @@ -15532,9 +16087,9 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - updateGist: *92 + updateGist: *95 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -15692,7 +16247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -15721,7 +16276,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *93 + - *96 - *17 - *18 responses: @@ -15731,7 +16286,7 @@ paths: application/json: schema: type: array - items: &94 + items: &97 title: Gist Comment description: A comment made to a gist. type: object @@ -15769,7 +16324,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *85 + author_association: *88 required: - url - id @@ -15834,7 +16389,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *93 + - *96 requestBody: required: true content: @@ -15860,9 +16415,9 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: &95 + default: &98 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -15920,8 +16475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *93 - - &97 + - *96 + - &100 name: comment_id description: The unique identifier of the comment. in: path @@ -15934,12 +16489,12 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: *95 + default: *98 '304': *35 '404': *6 - '403': *96 + '403': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15961,8 +16516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *93 - - *97 + - *96 + - *100 requestBody: required: true content: @@ -15988,9 +16543,9 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: *95 + default: *98 '404': *6 x-github: githubCloudOnly: false @@ -16007,8 +16562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *93 - - *97 + - *96 + - *100 responses: '204': description: Response @@ -16031,7 +16586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *93 + - *96 - *17 - *18 responses: @@ -16132,7 +16687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *93 + - *96 - *17 - *18 responses: @@ -16142,7 +16697,7 @@ paths: application/json: schema: type: array - items: *91 + items: *94 examples: default: value: @@ -16207,13 +16762,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *93 + - *96 responses: '201': description: Response content: application/json: - schema: *89 + schema: *92 examples: default: value: @@ -16284,7 +16839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *93 + - *96 responses: '204': description: Response if gist is starred @@ -16314,7 +16869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -16336,7 +16891,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -16365,7 +16920,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *93 + - *96 - name: sha in: path required: true @@ -16376,9 +16931,9 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - default: *92 + default: *95 '422': *15 '404': *6 '403': *27 @@ -16747,7 +17302,7 @@ paths: - closed - all default: open - - &199 + - &202 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16766,7 +17321,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - name: collab in: query required: false @@ -16796,9 +17351,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: &200 + default: &203 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17078,7 +17633,7 @@ paths: application/json: schema: type: array - items: *99 + items: *102 examples: default: value: @@ -17375,7 +17930,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &100 + X-CommonMarker-Version: &103 example: 0.17.4 schema: type: string @@ -17430,7 +17985,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *100 + X-CommonMarker-Version: *103 content: text/html: schema: @@ -17459,7 +18014,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: - - &103 + - &106 name: account_id description: account_id parameter in: path @@ -17471,7 +18026,7 @@ paths: description: Response content: application/json: - schema: &102 + schema: &105 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -17505,7 +18060,7 @@ paths: - 'null' id: type: integer - plan: &101 + plan: &104 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -17608,7 +18163,7 @@ paths: - 'null' updated_at: type: string - plan: *101 + plan: *104 required: - url - id @@ -17616,7 +18171,7 @@ paths: - login - marketplace_purchase examples: - default: &104 + default: &107 value: url: https://api.github.com/orgs/github type: Organization @@ -17701,9 +18256,9 @@ paths: application/json: schema: type: array - items: *101 + items: *104 examples: - default: &105 + default: &108 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -17743,14 +18298,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &106 + - &109 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &107 + - &110 name: sort description: The property to sort the results by. in: query @@ -17780,9 +18335,9 @@ paths: application/json: schema: type: array - items: *102 + items: *105 examples: - default: &108 + default: &111 value: - url: https://api.github.com/orgs/github type: Organization @@ -17856,15 +18411,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: - - *103 + - *106 responses: '200': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *104 + default: *107 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -17896,9 +18451,9 @@ paths: application/json: schema: type: array - items: *101 + items: *104 examples: - default: *105 + default: *108 headers: Link: *37 '401': *23 @@ -17921,8 +18476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *106 - - *107 + - *109 + - *110 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -17942,9 +18497,9 @@ paths: application/json: schema: type: array - items: *102 + items: *105 examples: - default: *108 + default: *111 headers: Link: *37 '401': *23 @@ -18194,14 +18749,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: - - &280 + - &283 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &281 + - &284 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -18218,7 +18773,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -18272,7 +18827,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &294 + '301': &297 description: Moved permanently content: application/json: @@ -18294,7 +18849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &484 + - &487 name: all description: If `true`, show notifications marked as read. in: query @@ -18302,7 +18857,7 @@ paths: schema: type: boolean default: false - - &485 + - &488 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -18311,8 +18866,8 @@ paths: schema: type: boolean default: false - - *88 - - &486 + - *91 + - &489 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: @@ -18337,14 +18892,14 @@ paths: application/json: schema: type: array - items: &110 + items: &113 title: Thread description: Thread type: object properties: id: type: string - repository: &132 + repository: &135 title: Minimal Repository description: Minimal Repository type: object @@ -18683,7 +19238,7 @@ paths: type: boolean examples: - false - security_and_analysis: &232 + security_and_analysis: &235 type: - object - 'null' @@ -18838,7 +19393,7 @@ paths: - url - subscription_url examples: - default: &487 + default: &490 value: - id: '1' repository: @@ -19004,7 +19559,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &111 + - &114 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 @@ -19018,7 +19573,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *113 examples: default: value: @@ -19121,7 +19676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *111 + - *114 responses: '205': description: Reset Content @@ -19144,7 +19699,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *111 + - *114 responses: '204': description: No content @@ -19167,13 +19722,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: - - *111 + - *114 responses: '200': description: Response content: application/json: - schema: &112 + schema: &115 title: Thread Subscription description: Thread Subscription type: object @@ -19217,7 +19772,7 @@ paths: - url - subscribed examples: - default: &113 + default: &116 value: subscribed: true ignored: false @@ -19248,7 +19803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *111 + - *114 requestBody: required: false content: @@ -19269,9 +19824,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *113 + default: *116 '304': *35 '403': *27 '401': *23 @@ -19294,7 +19849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *111 + - *114 responses: '204': description: Response @@ -19391,7 +19946,7 @@ paths: type: array items: *50 examples: - default: &619 + default: &622 value: - login: github id: 1 @@ -19456,7 +20011,7 @@ paths: - 3 custom_roles: type: array - items: &168 + items: &171 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -19505,7 +20060,7 @@ paths: - created_at - updated_at examples: - default: &169 + default: &172 value: id: 8030 name: Security Engineer @@ -19557,7 +20112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - &114 + - &117 name: org description: The organization name. The name is not case sensitive. in: path @@ -19569,7 +20124,7 @@ paths: description: Response content: application/json: - schema: &115 + schema: &118 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -19932,7 +20487,7 @@ paths: - updated_at - archived_at examples: - default-response: &116 + default-response: &119 value: login: github id: 1 @@ -20024,7 +20579,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *114 + - *117 requestBody: required: false content: @@ -20244,18 +20799,18 @@ paths: description: Response content: application/json: - schema: *115 + schema: *118 examples: - default: *116 + default: *119 '422': description: Validation failed content: application/json: schema: oneOf: - - *117 - - *118 - '409': *119 + - *120 + - *121 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20278,9 +20833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *114 + - *117 responses: - '202': *120 + '202': *123 '404': *6 '403': *27 x-github: @@ -20303,15 +20858,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *121 + schema: *124 examples: - default: *122 + default: *125 headers: Link: *37 x-github: @@ -20334,7 +20889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -20352,7 +20907,7 @@ paths: type: integer repository_cache_usages: type: array - items: &299 + items: &302 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20410,13 +20965,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *114 + - *117 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &123 + schema: &126 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20430,7 +20985,7 @@ paths: required: - include_claim_keys examples: - default: &124 + default: &127 value: include_claim_keys: - repo @@ -20452,20 +21007,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: *123 + schema: *126 examples: - default: *124 + default: *127 responses: '201': description: Empty response content: application/json: - schema: &143 + schema: &146 title: Empty Object description: An object without any properties. type: object @@ -20495,7 +21050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -20504,7 +21059,7 @@ paths: schema: type: object properties: - enabled_repositories: &126 + enabled_repositories: &129 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20518,7 +21073,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *40 - selected_actions_url: *125 + selected_actions_url: *128 required: - enabled_repositories examples: @@ -20547,7 +21102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20558,7 +21113,7 @@ paths: schema: type: object properties: - enabled_repositories: *126 + enabled_repositories: *129 allowed_actions: *40 required: - enabled_repositories @@ -20586,7 +21141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -20606,7 +21161,7 @@ paths: type: array items: *55 examples: - default: &613 + default: &616 value: total_count: 1 repositories: @@ -20746,7 +21301,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20790,8 +21345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *114 - - &127 + - *117 + - &130 name: repository_id description: The unique identifier of the repository. in: path @@ -20819,8 +21374,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *114 - - *127 + - *117 + - *130 responses: '204': description: Response @@ -20843,7 +21398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -20874,7 +21429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20906,13 +21461,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: default: *46 x-github: @@ -20935,7 +21490,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Success response @@ -20946,7 +21501,7 @@ paths: required: false content: application/json: - schema: *129 + schema: *132 examples: default: *46 x-github: @@ -20968,7 +21523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *114 + - *117 - *17 - *18 - name: visible_to_repository @@ -20993,7 +21548,7 @@ paths: type: number runner_groups: type: array - items: &130 + items: &133 type: object properties: id: @@ -21106,7 +21661,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -21176,9 +21731,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: &131 + default: &134 value: id: 2 name: octo-runner-group @@ -21213,14 +21768,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 - *49 responses: '200': description: Response content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -21256,7 +21811,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21308,9 +21863,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: *131 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21329,7 +21884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *114 + - *117 - *49 responses: '204': @@ -21353,7 +21908,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - *18 - *17 @@ -21372,9 +21927,9 @@ paths: type: number repositories: type: array - items: *132 + items: *135 examples: - default: &605 + default: &608 value: total_count: 1 repositories: @@ -21626,7 +22181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21671,9 +22226,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - - *127 + - *130 responses: '204': description: Response @@ -21695,9 +22250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - - *127 + - *130 responses: '204': description: Response @@ -21720,7 +22275,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *17 - *18 @@ -21762,7 +22317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21807,7 +22362,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *52 responses: @@ -21831,7 +22386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *52 responses: @@ -21863,7 +22418,7 @@ paths: in: query schema: type: string - - *114 + - *117 - *17 - *18 responses: @@ -21907,7 +22462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -21915,9 +22470,9 @@ paths: application/json: schema: type: array - items: *133 + items: *136 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21939,7 +22494,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -21982,7 +22537,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *135 + '201': *138 '404': *6 '422': *7 x-github: @@ -22012,7 +22567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *114 + - *117 responses: '201': description: Response @@ -22020,7 +22575,7 @@ paths: application/json: schema: *56 examples: - default: *136 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22048,7 +22603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *114 + - *117 responses: '201': description: Response @@ -22056,7 +22611,7 @@ paths: application/json: schema: *56 examples: - default: *137 + default: *140 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22078,7 +22633,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: '200': @@ -22087,7 +22642,7 @@ paths: application/json: schema: *53 examples: - default: *138 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22108,7 +22663,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *114 + - *117 - *52 responses: '204': @@ -22134,7 +22689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: '200': *58 @@ -22159,7 +22714,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 requestBody: required: true @@ -22208,7 +22763,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 requestBody: required: true @@ -22258,10 +22813,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: - '200': *139 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -22288,9 +22843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 - - *140 + - *143 responses: '200': *58 '404': *6 @@ -22317,7 +22872,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -22335,7 +22890,7 @@ paths: type: integer secrets: type: array - items: &141 + items: &144 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22410,13 +22965,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &319 + schema: &322 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22451,7 +23006,7 @@ paths: - key_id - key examples: - default: &320 + default: &323 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22476,8 +23031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *114 - - &142 + - *117 + - &145 name: secret_name description: The name of the secret. in: path @@ -22489,7 +23044,7 @@ paths: description: Response content: application/json: - schema: *141 + schema: *144 examples: default: value: @@ -22519,8 +23074,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -22575,7 +23130,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -22601,8 +23156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -22628,8 +23183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -22647,9 +23202,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: &146 + default: &149 value: total_count: 1 repositories: @@ -22741,8 +23296,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -22794,8 +23349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -22828,8 +23383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -22861,8 +23416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *114 - - &304 + - *117 + - &307 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)." @@ -22886,7 +23441,7 @@ paths: type: integer variables: type: array - items: &144 + items: &147 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22976,7 +23531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *114 + - *117 requestBody: required: true content: @@ -23024,7 +23579,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -23049,8 +23604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *114 - - &145 + - *117 + - &148 name: name description: The name of the variable. in: path @@ -23062,7 +23617,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: default: value: @@ -23092,8 +23647,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 requestBody: required: true content: @@ -23155,8 +23710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 responses: '204': description: Response @@ -23182,8 +23737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - *18 - *17 responses: @@ -23201,9 +23756,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23229,8 +23784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 requestBody: required: true content: @@ -23279,8 +23834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - name: repository_id in: path required: true @@ -23314,8 +23869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - name: repository_id in: path required: true @@ -23346,7 +23901,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -23373,11 +23928,11 @@ paths: required: true content: application/json: - schema: *147 + schema: *150 examples: default: *61 parameters: - - *114 + - *117 responses: '200': description: Response @@ -23401,7 +23956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -23429,7 +23984,7 @@ paths: - *17 - *63 - *64 - - *114 + - *117 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23470,7 +24025,7 @@ paths: repository_id: type: integer examples: - default: &333 + default: &336 value: attestations: - bundle: @@ -23588,7 +24143,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *114 + - *117 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -23596,10 +24151,10 @@ paths: required: false schema: type: string - - *148 - - *149 - - *150 - *151 + - *152 + - *153 + - *154 - *17 responses: '200': @@ -23608,9 +24163,9 @@ paths: application/json: schema: type: array - items: *152 + items: *155 examples: - default: *153 + default: *156 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23627,7 +24182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -23639,7 +24194,7 @@ paths: type: array items: *4 examples: - default: &201 + default: &204 value: - login: octocat id: 1 @@ -23677,8 +24232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *114 - - &154 + - *117 + - &157 name: username description: The handle for the GitHub user account. in: path @@ -23709,8 +24264,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -23730,8 +24285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -23756,9 +24311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *114 - - *155 - - *156 + - *117 + - *158 + - *159 - *63 - *64 - *18 @@ -23769,7 +24324,7 @@ paths: be returned. in: query required: false - schema: *157 + schema: *160 - name: sort description: The property by which to sort the results. in: query @@ -23785,7 +24340,7 @@ paths: be returned. in: query required: false - schema: &359 + schema: &362 type: string description: Severity of a code scanning alert. enum: @@ -23803,9 +24358,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *159 + default: *162 headers: Link: *37 '404': *6 @@ -23831,7 +24386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *114 + - *117 - name: target_type in: query description: The target type of the code security configuration @@ -23859,7 +24414,7 @@ paths: application/json: schema: type: array - items: &160 + items: &163 type: object description: A code security configuration properties: @@ -24098,7 +24653,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *114 + - *117 requestBody: required: true content: @@ -24270,9 +24825,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *160 + schema: *163 examples: - default: &161 + default: &164 value: id: 1325 target_type: organization @@ -24318,7 +24873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *114 + - *117 responses: '200': description: Response @@ -24338,7 +24893,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *160 + configuration: *163 examples: default: value: @@ -24422,7 +24977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *114 + - *117 requestBody: required: true content: @@ -24445,12 +25000,12 @@ paths: - 32 - 91 responses: - '204': &163 + '204': &166 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24472,8 +25027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *114 - - &162 + - *117 + - &165 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -24485,9 +25040,9 @@ paths: description: Response content: application/json: - schema: *160 + schema: *163 examples: - default: *161 + default: *164 '304': *35 '403': *27 '404': *6 @@ -24511,8 +25066,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24664,7 +25219,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *160 + schema: *163 examples: default: value: @@ -24715,14 +25270,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 responses: - '204': *163 + '204': *166 '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24746,8 +25301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24786,7 +25341,7 @@ paths: - 32 - 91 responses: - '202': *120 + '202': *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24810,8 +25365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24851,12 +25406,12 @@ paths: - none - private_and_internal - public - configuration: *160 + configuration: *163 examples: default: value: default_for_new_repos: all - configuration: *161 + configuration: *164 '403': *27 '404': *6 x-github: @@ -24880,8 +25435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 - 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)." @@ -25024,7 +25579,7 @@ paths: parameters: - *17 - *18 - - *114 + - *117 responses: '200': description: Response @@ -25040,7 +25595,7 @@ paths: type: integer codespaces: type: array - items: &202 + items: &205 type: object title: Codespace description: A codespace. @@ -25071,11 +25626,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *132 + repository: *135 machine: anyOf: - type: 'null' - - &385 + - &388 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -25362,7 +25917,7 @@ paths: - pulls_url - recent_folders examples: - default: &203 + default: &206 value: total_count: 3 codespaces: @@ -25794,7 +26349,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *114 + - *117 deprecated: true requestBody: required: true @@ -25861,7 +26416,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *114 + - *117 deprecated: true requestBody: required: true @@ -25916,7 +26471,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *114 + - *117 requestBody: required: true content: @@ -25968,7 +26523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -25986,7 +26541,7 @@ paths: type: integer secrets: type: array - items: &164 + items: &167 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26027,7 +26582,7 @@ paths: - updated_at - visibility examples: - default: &386 + default: &389 value: total_count: 2 secrets: @@ -26059,13 +26614,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &387 + schema: &390 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26100,7 +26655,7 @@ paths: - key_id - key examples: - default: &388 + default: &391 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26123,16 +26678,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '200': description: Response content: application/json: - schema: *164 + schema: *167 examples: - default: &390 + default: &393 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26159,8 +26714,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -26215,7 +26770,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -26241,8 +26796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -26267,8 +26822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -26286,9 +26841,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 '404': *6 x-github: githubCloudOnly: false @@ -26310,8 +26865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -26361,8 +26916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -26395,8 +26950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -26435,7 +26990,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *114 + - *117 responses: '200': description: OK @@ -26575,7 +27130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *114 + - *117 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -26598,9 +27153,9 @@ paths: currently being billed. seats: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 headers: Link: *37 '500': *69 @@ -26638,7 +27193,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26716,7 +27271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26797,7 +27352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26875,7 +27430,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26931,6 +27486,74 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - *117 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -26956,7 +27579,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *114 + - *117 - 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`). @@ -26988,9 +27611,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: *167 + default: *170 '500': *69 '401': *23 '403': *27 @@ -27016,7 +27639,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -27175,7 +27798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *114 + - *117 - name: credential_id in: path required: true @@ -27206,7 +27829,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *114 + - *117 responses: '200': description: Response - list of custom role names @@ -27222,7 +27845,7 @@ paths: - 3 custom_roles: type: array - items: *168 + items: *171 examples: default: value: @@ -27309,12 +27932,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: &171 + schema: &174 type: object properties: name: @@ -27356,9 +27979,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27382,8 +28005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *114 - - &170 + - *117 + - &173 name: role_id description: The unique identifier of the role. in: path @@ -27395,9 +28018,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '404': *6 x-github: githubCloudOnly: true @@ -27419,13 +28042,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: application/json: - schema: &172 + schema: &175 type: object properties: name: @@ -27464,9 +28087,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27490,8 +28113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -27519,12 +28142,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27538,9 +28161,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27570,16 +28193,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '200': description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '404': *6 x-github: githubCloudOnly: true @@ -27607,13 +28230,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: application/json: - schema: *172 + schema: *175 examples: default: value: @@ -27628,9 +28251,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27660,8 +28283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -27689,18 +28312,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *114 - - *173 - - *174 - - *175 + - *117 - *176 - *177 - *178 + - *179 + - *180 + - *181 - *65 - *63 - *64 - - *179 - - *180 + - *182 + - *183 - *17 responses: '200': @@ -27709,9 +28332,9 @@ paths: application/json: schema: type: array - items: *181 + items: *184 examples: - default: *182 + default: *185 '304': *35 '400': *14 '403': *27 @@ -27737,7 +28360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -27755,7 +28378,7 @@ paths: type: integer secrets: type: array - items: &183 + items: &186 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27828,13 +28451,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &413 + schema: &416 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27853,7 +28476,7 @@ paths: - key_id - key examples: - default: &414 + default: &417 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27876,14 +28499,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '200': description: Response content: application/json: - schema: *183 + schema: *186 examples: default: value: @@ -27911,8 +28534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -27967,7 +28590,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -27991,8 +28614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -28016,8 +28639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -28035,9 +28658,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28058,8 +28681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -28109,8 +28732,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -28141,8 +28764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -28172,7 +28795,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -28180,7 +28803,7 @@ paths: application/json: schema: type: array - items: &213 + items: &216 title: Package description: A software package type: object @@ -28233,7 +28856,7 @@ paths: repository: anyOf: - type: 'null' - - *132 + - *135 created_at: type: string format: date-time @@ -28251,7 +28874,7 @@ paths: - created_at - updated_at examples: - default: &214 + default: &217 value: - id: 197 name: hello_docker @@ -28329,7 +28952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28339,7 +28962,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: 200-response: value: @@ -28409,7 +29032,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *114 + - *117 - name: group_id description: The unique identifier of the group. in: path @@ -28435,7 +29058,7 @@ paths: description: Response content: application/json: - schema: &275 + schema: &278 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -28525,7 +29148,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &276 + default: &279 value: group_id: '123' group_name: Octocat admins @@ -28563,7 +29186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -28580,7 +29203,7 @@ paths: description: Response content: application/json: - schema: &273 + schema: &276 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -28620,7 +29243,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &274 + default: &277 value: groups: - group_id: '123' @@ -28654,7 +29277,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28664,7 +29287,7 @@ paths: application/json: schema: type: array - items: &195 + items: &198 title: Organization Invitation description: Organization Invitation type: object @@ -28718,7 +29341,7 @@ paths: - invitation_teams_url - node_id examples: - default: &196 + default: &199 value: - id: 1 login: monalisa @@ -28777,7 +29400,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -28785,7 +29408,7 @@ paths: application/json: schema: type: array - items: &233 + items: &236 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -28799,7 +29422,7 @@ paths: - name - description examples: - default: &234 + default: &237 value: - name: add_assignee description: Assign or remove a user @@ -28830,7 +29453,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28840,7 +29463,7 @@ paths: application/json: schema: type: array - items: &184 + items: &187 title: Org Hook description: Org Hook type: object @@ -28961,7 +29584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *114 + - *117 requestBody: required: true content: @@ -29023,9 +29646,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: &185 + default: &188 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29069,8 +29692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *114 - - &186 + - *117 + - &189 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. @@ -29083,9 +29706,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: *185 + default: *188 '404': *6 x-github: githubCloudOnly: false @@ -29106,8 +29729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 requestBody: required: false content: @@ -29153,7 +29776,7 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: default: value: @@ -29192,8 +29815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 responses: '204': description: Response @@ -29218,8 +29841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *114 - - *186 + - *117 + - *189 responses: '200': description: Response @@ -29247,8 +29870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *114 - - *186 + - *117 + - *189 requestBody: required: false content: @@ -29296,10 +29919,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *17 - - *187 + - *190 - name: redelivery in: query required: false @@ -29312,9 +29935,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '400': *14 '422': *15 x-github: @@ -29337,17 +29960,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: - default: *191 + default: *194 '400': *14 '422': *15 x-github: @@ -29370,11 +29993,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *16 responses: - '202': *120 + '202': *123 '400': *14 '422': *15 x-github: @@ -29397,8 +30020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 responses: '204': description: Response @@ -29422,7 +30045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *114 + - *117 responses: '200': description: Response @@ -29430,7 +30053,7 @@ paths: application/json: schema: *20 examples: - default: &452 + default: &455 value: id: 1 account: @@ -29499,7 +30122,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -29588,7 +30211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -29596,12 +30219,12 @@ paths: application/json: schema: anyOf: - - &193 + - &196 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &192 + limit: &195 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -29629,7 +30252,7 @@ paths: properties: {} additionalProperties: false examples: - default: &194 + default: &197 value: limit: collaborators_only origin: organization @@ -29653,18 +30276,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: &453 + schema: &456 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *192 + limit: *195 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -29689,9 +30312,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *194 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -29709,7 +30332,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -29735,7 +30358,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *114 + - *117 - *17 - *18 - name: role @@ -29769,9 +30392,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 '404': *6 @@ -29795,7 +30418,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *114 + - *117 requestBody: required: false content: @@ -29849,7 +30472,7 @@ paths: description: Response content: application/json: - schema: *195 + schema: *198 examples: default: value: @@ -29905,8 +30528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *114 - - &197 + - *117 + - &200 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29939,8 +30562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *114 - - *197 + - *117 + - *200 - *17 - *18 responses: @@ -29950,9 +30573,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: &212 + default: &215 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29997,7 +30620,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *114 + - *117 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -30027,7 +30650,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -30040,7 +30663,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -30050,9 +30673,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: *200 + default: *203 headers: Link: *37 '404': *6 @@ -30074,7 +30697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *114 + - *117 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -30110,7 +30733,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '422': *15 @@ -30130,8 +30753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response if requester is an organization member and user is @@ -30162,8 +30785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -30189,8 +30812,8 @@ paths: parameters: - *17 - *18 - - *114 - - *154 + - *117 + - *157 responses: '200': description: Response @@ -30206,9 +30829,9 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *35 '500': *69 '401': *23 @@ -30233,9 +30856,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *114 - - *154 - - &204 + - *117 + - *157 + - &207 name: codespace_name in: path required: true @@ -30243,7 +30866,7 @@ paths: schema: type: string responses: - '202': *120 + '202': *123 '304': *35 '500': *69 '401': *23 @@ -30268,17 +30891,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *114 - - *154 - - *204 + - *117 + - *157 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: &384 + default: &387 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -30448,14 +31071,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -30523,14 +31146,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '200': description: Response content: application/json: - schema: &205 + schema: &208 title: Org Membership description: Org Membership type: object @@ -30583,7 +31206,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &206 + response-if-user-has-an-active-admin-membership-with-organization: &209 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -30651,8 +31274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 requestBody: required: false content: @@ -30680,9 +31303,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *208 examples: - response-if-user-already-had-membership-with-organization: *206 + response-if-user-already-had-membership-with-organization: *209 '422': *15 '403': *27 x-github: @@ -30703,8 +31326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -30729,7 +31352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *114 + - *117 - *17 - *18 - name: exclude @@ -30751,7 +31374,7 @@ paths: application/json: schema: type: array - items: &207 + items: &210 title: Migration description: A migration. type: object @@ -31008,7 +31631,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *114 + - *117 requestBody: required: true content: @@ -31089,7 +31712,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -31267,8 +31890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *114 - - &208 + - *117 + - &211 name: migration_id description: The unique identifier of the migration. in: path @@ -31296,7 +31919,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -31465,8 +32088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *114 - - *208 + - *117 + - *211 responses: '302': description: Response @@ -31487,8 +32110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *114 - - *208 + - *117 + - *211 responses: '204': description: Response @@ -31511,9 +32134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *114 - - *208 - - &618 + - *117 + - *211 + - &621 name: repo_name description: repo_name parameter in: path @@ -31540,8 +32163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *114 - - *208 + - *117 + - *211 - *17 - *18 responses: @@ -31551,9 +32174,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: &219 + default: &222 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31692,7 +32315,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -31746,7 +32369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response - list of organization roles @@ -31762,7 +32385,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &209 + items: &212 title: Organization Role description: Organization roles type: object @@ -31900,7 +32523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *114 + - *117 requestBody: required: true content: @@ -31947,7 +32570,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -31976,7 +32599,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -31998,8 +32621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -32024,9 +32647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *114 - - *210 - - *170 + - *117 + - *213 + - *173 responses: '204': description: Response @@ -32055,9 +32678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *114 - - *210 - - *170 + - *117 + - *213 + - *173 responses: '204': description: Response @@ -32082,8 +32705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -32108,9 +32731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *114 - - *154 - - *170 + - *117 + - *157 + - *173 responses: '204': description: Response @@ -32140,9 +32763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *114 - - *154 - - *170 + - *117 + - *157 + - *173 responses: '204': description: Response @@ -32170,14 +32793,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '200': description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -32234,8 +32857,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: @@ -32274,7 +32897,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -32302,7 +32925,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *119 + '409': *122 '404': *6 x-github: githubCloudOnly: true @@ -32327,8 +32950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -32353,8 +32976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 - *17 - *18 responses: @@ -32423,7 +33046,7 @@ paths: parent: anyOf: - type: 'null' - - *211 + - *214 required: - id - node_id @@ -32437,7 +33060,7 @@ paths: - slug - parent examples: - default: *212 + default: *215 headers: Link: *37 '404': @@ -32466,8 +33089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 - *17 - *18 responses: @@ -32599,7 +33222,7 @@ paths: - type - url examples: - default: *201 + default: *204 headers: Link: *37 '404': @@ -32623,7 +33246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *114 + - *117 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -32647,7 +33270,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -32672,8 +33295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *114 - - *154 + - *117 + - *157 requestBody: required: false content: @@ -32730,8 +33353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -32788,8 +33411,8 @@ paths: - docker - nuget - container - - *114 - - &620 + - *117 + - &623 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -32825,12 +33448,12 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *214 + default: *217 '403': *27 '401': *23 - '400': &622 + '400': &625 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -32852,7 +33475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &215 + - &218 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 @@ -32870,20 +33493,20 @@ paths: - docker - nuget - container - - &216 + - &219 name: package_name description: The name of the package. in: path required: true schema: type: string - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: default: value: @@ -32935,9 +33558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 responses: '204': description: Response @@ -32969,9 +33592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 - name: token description: package token schema: @@ -33003,9 +33626,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 - *18 - *17 - name: state @@ -33025,7 +33648,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Package Version description: A version of a software package type: object @@ -33160,10 +33783,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: - - *215 - - *216 - - *114 - - &218 + - *218 + - *219 + - *117 + - &221 name: package_version_id description: Unique identifier of the package version. in: path @@ -33175,7 +33798,7 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -33211,10 +33834,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *215 - - *216 - - *114 - *218 + - *219 + - *117 + - *221 responses: '204': description: Response @@ -33246,10 +33869,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *215 - - *216 - - *114 - *218 + - *219 + - *117 + - *221 responses: '204': description: Response @@ -33276,10 +33899,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *114 + - *117 - *17 - *18 - - &220 + - &223 name: sort description: The property by which to sort the results. in: query @@ -33290,7 +33913,7 @@ paths: - created_at default: created_at - *65 - - &221 + - &224 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -33302,7 +33925,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &222 + - &225 name: repository description: The name of the repository to use to filter the results. in: query @@ -33311,7 +33934,7 @@ paths: type: string examples: - Hello-World - - &223 + - &226 name: permission description: The permission to use to filter the results. in: query @@ -33320,7 +33943,7 @@ paths: type: string examples: - issues_read - - &224 + - &227 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) @@ -33330,7 +33953,7 @@ paths: schema: type: string format: date-time - - &225 + - &228 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) @@ -33482,7 +34105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *114 + - *117 requestBody: required: true content: @@ -33528,7 +34151,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *120 + '202': *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33549,7 +34172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *114 + - *117 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -33590,7 +34213,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *163 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33611,7 +34234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *114 + - *117 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -33631,9 +34254,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -33656,16 +34279,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *114 + - *117 - *17 - *18 - - *220 - - *65 - - *221 - - *222 - *223 + - *65 - *224 - *225 + - *226 + - *227 + - *228 responses: '500': *69 '422': *15 @@ -33802,7 +34425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *114 + - *117 requestBody: required: true content: @@ -33839,7 +34462,7 @@ paths: responses: '500': *69 '404': *6 - '202': *120 + '202': *123 '403': *27 '422': *15 x-github: @@ -33862,7 +34485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *114 + - *117 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -33892,7 +34515,7 @@ paths: responses: '500': *69 '404': *6 - '204': *163 + '204': *166 '403': *27 '422': *15 x-github: @@ -33914,7 +34537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *114 + - *117 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -33933,9 +34556,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -33957,7 +34580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *114 + - *117 - name: state description: Indicates the state of the projects to return. in: query @@ -33978,7 +34601,7 @@ paths: application/json: schema: type: array - items: &226 + items: &229 title: Project description: Projects are a way to organize columns and cards of work. @@ -34131,7 +34754,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *114 + - *117 requestBody: required: true content: @@ -34157,7 +34780,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: default: value: @@ -34195,7 +34818,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &291 + '410': &294 description: Gone content: application/json: @@ -34219,7 +34842,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -34227,7 +34850,7 @@ paths: application/json: schema: type: array - items: &227 + items: &230 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -34295,7 +34918,7 @@ paths: - property_name - value_type examples: - default: &228 + default: &231 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34336,7 +34959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -34347,7 +34970,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *227 + items: *230 minItems: 1 maxItems: 100 required: @@ -34377,9 +35000,9 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: - default: *228 + default: *231 '403': *27 '404': *6 x-github: @@ -34400,8 +35023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *114 - - &229 + - *117 + - &232 name: custom_property_name description: The custom property name in: path @@ -34413,9 +35036,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: - default: &230 + default: &233 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34448,8 +35071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *114 - - *229 + - *117 + - *232 requestBody: required: true content: @@ -34514,9 +35137,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: - default: *230 + default: *233 '403': *27 '404': *6 x-github: @@ -34539,10 +35162,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *114 - - *229 + - *117 + - *232 responses: - '204': *163 + '204': *166 '403': *27 '404': *6 x-github: @@ -34563,7 +35186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *114 + - *117 - *17 - *18 - name: repository_query @@ -34604,7 +35227,7 @@ paths: - octocat/Hello-World properties: type: array - items: &231 + items: &234 title: Custom Property Value description: Custom property name and associated value type: object @@ -34674,7 +35297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *114 + - *117 requestBody: required: true content: @@ -34694,7 +35317,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *231 + items: *234 required: - repository_names - properties @@ -34735,7 +35358,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *114 + - *117 - *17 - *18 responses: @@ -34747,7 +35370,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -34766,8 +35389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response if user is a public member @@ -34791,8 +35414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -34813,8 +35436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -34838,7 +35461,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *114 + - *117 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -34885,9 +35508,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -34908,7 +35531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *114 + - *117 requestBody: required: true content: @@ -35091,7 +35714,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &296 title: Full Repository description: Full Repository type: object @@ -35537,7 +36160,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 organization: anyOf: - type: 'null' @@ -35556,7 +36179,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &403 + code_of_conduct: &406 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -35586,7 +36209,7 @@ paths: - key - name - html_url - security_and_analysis: *232 + security_and_analysis: *235 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -35670,7 +36293,7 @@ paths: - network_count - subscribers_count examples: - default: &295 + default: &298 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36188,7 +36811,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -36196,9 +36819,9 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: - default: *234 + default: *237 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36220,10 +36843,10 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - *17 - *18 - - &533 + - &536 name: targets description: | A comma-separated list of rule targets to filter by. @@ -36242,7 +36865,7 @@ paths: application/json: schema: type: array - items: &241 + items: &244 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -36275,7 +36898,7 @@ paths: source: type: string description: The name of the source - enforcement: &237 + enforcement: &240 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -36287,7 +36910,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &238 + items: &241 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -36355,7 +36978,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &235 + - &238 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -36379,7 +37002,7 @@ paths: match. items: type: string - - &239 + - &242 title: Organization ruleset conditions type: object description: |- @@ -36392,7 +37015,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -36426,7 +37049,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -36448,7 +37071,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -36461,7 +37084,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &236 + items: &239 title: Repository ruleset property targeting definition type: object @@ -36494,7 +37117,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *236 + items: *239 required: - repository_property type: @@ -36502,12 +37125,12 @@ paths: - object rules: type: array - items: &240 + items: &243 title: Repository Rule type: object description: A repository rule. oneOf: - - &515 + - &518 title: creation description: Only allow users with bypass permission to create matching refs. @@ -36519,7 +37142,7 @@ paths: type: string enum: - creation - - &516 + - &519 title: update description: Only allow users with bypass permission to update matching refs. @@ -36540,7 +37163,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &518 + - &521 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -36552,7 +37175,7 @@ paths: type: string enum: - deletion - - &519 + - &522 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -36564,7 +37187,7 @@ paths: type: string enum: - required_linear_history - - &520 + - &523 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -36642,7 +37265,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &521 + - &524 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -36666,7 +37289,7 @@ paths: type: string required: - required_deployment_environments - - &522 + - &525 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -36678,7 +37301,7 @@ paths: type: string enum: - required_signatures - - &523 + - &526 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -36724,7 +37347,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &524 + - &527 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -36772,7 +37395,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &525 + - &528 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -36784,7 +37407,7 @@ paths: type: string enum: - non_fast_forward - - &526 + - &529 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -36820,7 +37443,7 @@ paths: required: - operator - pattern - - &527 + - &530 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -36856,7 +37479,7 @@ paths: required: - operator - pattern - - &528 + - &531 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -36892,7 +37515,7 @@ paths: required: - operator - pattern - - &529 + - &532 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -36928,7 +37551,7 @@ paths: required: - operator - pattern - - &530 + - &533 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -37054,7 +37677,7 @@ paths: maximum: 100 required: - max_file_size - - &531 + - &534 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -37104,7 +37727,7 @@ paths: - repository_id required: - workflows - - &532 + - &535 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -37217,7 +37840,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 requestBody: description: Request body required: true @@ -37237,16 +37860,16 @@ paths: - tag - push default: branch - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *239 + items: *241 + conditions: *242 rules: type: array description: An array of rules within the ruleset. - items: *240 + items: *243 required: - name - enforcement @@ -37284,9 +37907,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: &242 + default: &245 value: id: 21 name: super cool ruleset @@ -37340,8 +37963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *114 - - &534 + - *117 + - &537 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 @@ -37357,7 +37980,7 @@ paths: in: query schema: type: integer - - &535 + - &538 name: time_period description: |- The time period to filter by. @@ -37373,14 +37996,14 @@ paths: - week - month default: day - - &536 + - &539 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 - - &537 + - &540 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -37400,7 +38023,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &541 title: Rule Suites description: Response type: array @@ -37456,7 +38079,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &539 + default: &542 value: - id: 21 actor_id: 12 @@ -37499,8 +38122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *114 - - &540 + - *117 + - &543 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -37516,7 +38139,7 @@ paths: description: Response content: application/json: - schema: &541 + schema: &544 title: Rule Suite description: Response type: object @@ -37623,7 +38246,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &542 + default: &545 value: id: 21 actor_id: 12 @@ -37684,7 +38307,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37696,9 +38319,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *242 + default: *245 '404': *6 '500': *69 put: @@ -37716,7 +38339,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37741,16 +38364,16 @@ paths: - branch - tag - push - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *239 + items: *241 + conditions: *242 rules: description: An array of rules within the ruleset. type: array - items: *240 + items: *243 examples: default: value: @@ -37785,9 +38408,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *242 + default: *245 '404': *6 '500': *69 delete: @@ -37805,7 +38428,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37833,15 +38456,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *114 - - *243 - - *244 - - *245 + - *117 - *246 + - *247 + - *248 + - *249 - *65 - *18 - *17 - - &544 + - &547 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 @@ -37851,7 +38474,7 @@ paths: required: false schema: type: string - - &545 + - &548 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 @@ -37861,9 +38484,9 @@ paths: required: false schema: type: string - - *247 - - *248 - - *249 + - *250 + - *251 + - *252 responses: '200': description: Response @@ -37871,9 +38494,9 @@ paths: application/json: schema: type: array - items: *250 + items: *253 examples: - default: *251 + default: *254 headers: Link: *37 '404': *6 @@ -37899,7 +38522,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *114 + - *117 - *65 - name: sort description: The property to sort the results by. @@ -37943,7 +38566,7 @@ paths: application/json: schema: type: array - items: &551 + items: &554 description: A repository security advisory. type: object properties: @@ -38187,7 +38810,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 credits_detailed: type: - array @@ -38198,7 +38821,7 @@ paths: type: object properties: user: *4 - type: *252 + type: *255 state: type: string description: The state of the user's acceptance of the @@ -38224,7 +38847,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *198 + items: *201 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -38262,7 +38885,7 @@ paths: - private_fork additionalProperties: false examples: - default: &552 + default: &555 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -38644,7 +39267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *114 + - *117 responses: '200': description: Response @@ -38652,9 +39275,9 @@ paths: application/json: schema: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38677,8 +39300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -38703,8 +39326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -38730,15 +39353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38762,7 +39385,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -38770,9 +39393,9 @@ paths: description: Success content: application/json: - schema: *255 + schema: *258 examples: - default: *256 + default: *259 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -38794,15 +39417,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *257 + schema: *260 examples: - default: *258 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38824,15 +39447,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *259 + schema: *262 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38849,7 +39472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -38868,7 +39491,7 @@ paths: description: Response content: application/json: - schema: &282 + schema: &285 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -38920,7 +39543,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &283 + default: &286 value: groups: - group_id: '123' @@ -38941,6 +39564,75 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - *117 + - *213 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -38969,8 +39661,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 - 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`). @@ -39002,9 +39694,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: *167 + default: *170 '500': *69 '401': *23 '403': *27 @@ -39026,7 +39718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *114 + - *117 - *17 - *18 responses: @@ -39036,9 +39728,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 headers: Link: *37 '403': *27 @@ -39060,7 +39752,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *114 + - *117 requestBody: required: true content: @@ -39132,7 +39824,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &264 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -39206,7 +39898,7 @@ paths: parent: anyOf: - type: 'null' - - *211 + - *214 members_count: type: integer examples: @@ -39512,7 +40204,7 @@ paths: - repos_count - organization examples: - default: &262 + default: &265 value: id: 1 node_id: MDQ6VGVhbTE= @@ -39582,16 +40274,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 x-github: githubCloudOnly: false @@ -39612,8 +40304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: false content: @@ -39676,16 +40368,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '201': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 '422': *15 '403': *27 @@ -39710,8 +40402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -39737,8 +40429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *114 - - *210 + - *117 + - *213 - *65 - *17 - *18 @@ -39755,7 +40447,7 @@ paths: application/json: schema: type: array - items: &263 + items: &266 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -39846,7 +40538,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *86 + reactions: *89 required: - author - body @@ -39866,7 +40558,7 @@ paths: - updated_at - url examples: - default: &592 + default: &595 value: - author: login: octocat @@ -39940,8 +40632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -39975,9 +40667,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: &264 + default: &267 value: author: login: octocat @@ -40049,9 +40741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *114 - - *210 - - &265 + - *117 + - *213 + - &268 name: discussion_number description: The number that identifies the discussion. in: path @@ -40063,9 +40755,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40087,9 +40779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: false content: @@ -40112,9 +40804,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: &593 + default: &596 value: author: login: octocat @@ -40184,9 +40876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 responses: '204': description: Response @@ -40212,9 +40904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 - *65 - *17 - *18 @@ -40225,7 +40917,7 @@ paths: application/json: schema: type: array - items: &266 + items: &269 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -40290,7 +40982,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *86 + reactions: *89 required: - author - body @@ -40305,7 +40997,7 @@ paths: - updated_at - url examples: - default: &594 + default: &597 value: - author: login: octocat @@ -40373,9 +41065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: true content: @@ -40397,9 +41089,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: &267 + default: &270 value: author: login: octocat @@ -40465,10 +41157,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *114 - - *210 - - *265 - - &268 + - *117 + - *213 + - *268 + - &271 name: comment_number description: The number that identifies the comment. in: path @@ -40480,9 +41172,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40504,10 +41196,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 requestBody: required: true content: @@ -40529,9 +41221,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: &595 + default: &598 value: author: login: octocat @@ -40595,10 +41287,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 responses: '204': description: Response @@ -40624,10 +41316,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 - 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. @@ -40653,7 +41345,7 @@ paths: application/json: schema: type: array - items: &269 + items: &272 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -40697,7 +41389,7 @@ paths: - content - created_at examples: - default: &271 + default: &274 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40747,10 +41439,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 requestBody: required: true content: @@ -40783,9 +41475,9 @@ paths: team discussion comment content: application/json: - schema: *269 + schema: *272 examples: - default: &270 + default: &273 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40814,9 +41506,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40839,11 +41531,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 - - &272 + - *271 + - &275 name: reaction_id description: The unique identifier of the reaction. in: path @@ -40875,9 +41567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 - 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. @@ -40903,9 +41595,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -40931,9 +41623,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: true content: @@ -40965,16 +41657,16 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40997,10 +41689,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *114 - - *210 - - *265 - - *272 + - *117 + - *213 + - *268 + - *275 responses: '204': description: Response @@ -41023,16 +41715,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -41051,8 +41743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -41076,9 +41768,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -41097,8 +41789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -41122,8 +41814,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41133,9 +41825,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 x-github: @@ -41157,8 +41849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *114 - - *210 + - *117 + - *213 - name: role description: Filters members returned by their role in the team. in: query @@ -41181,7 +41873,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -41211,15 +41903,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 responses: '200': description: Response content: application/json: - schema: &277 + schema: &280 title: Team Membership description: Team Membership type: object @@ -41247,7 +41939,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &596 + response-if-user-is-a-team-maintainer: &599 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -41283,9 +41975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 requestBody: required: false content: @@ -41310,9 +42002,9 @@ paths: description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-users-membership-with-team-is-now-pending: &597 + response-if-users-membership-with-team-is-now-pending: &600 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -41347,9 +42039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 responses: '204': description: Response @@ -41375,8 +42067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41386,7 +42078,7 @@ paths: application/json: schema: type: array - items: &278 + items: &281 title: Team Project description: A team's access to a project. type: object @@ -41455,7 +42147,7 @@ paths: - updated_at - permissions examples: - default: &598 + default: &601 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41516,9 +42208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *114 - - *210 - - &279 + - *117 + - *213 + - &282 name: project_id description: The unique identifier of the project. in: path @@ -41530,9 +42222,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &599 + default: &602 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41592,9 +42284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *114 - - *210 - - *279 + - *117 + - *213 + - *282 requestBody: required: false content: @@ -41659,9 +42351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *114 - - *210 - - *279 + - *117 + - *213 + - *282 responses: '204': description: Response @@ -41685,8 +42377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41696,9 +42388,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -41727,16 +42419,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &600 + schema: &603 title: Team Repository description: A team's access to a repository. type: object @@ -41762,7 +42454,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 forks: type: integer permissions: @@ -42377,10 +43069,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 requestBody: required: false content: @@ -42425,10 +43117,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 responses: '204': description: Response @@ -42454,16 +43146,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *282 + schema: *285 examples: - default: *283 + default: *286 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -42485,8 +43177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -42529,7 +43221,7 @@ paths: description: Response content: application/json: - schema: *282 + schema: *285 examples: default: value: @@ -42561,8 +43253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -42572,9 +43264,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - response-if-child-teams-exist: &601 + response-if-child-teams-exist: &604 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -42627,7 +43319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *114 + - *117 - name: security_product in: path description: The security feature to enable or disable. @@ -42698,7 +43390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &284 + - &287 name: card_id description: The unique identifier of the card. in: path @@ -42710,7 +43402,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &288 title: Project Card description: Project cards represent a scope of work. type: object @@ -42785,7 +43477,7 @@ paths: - created_at - updated_at examples: - default: &286 + default: &289 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -42835,7 +43527,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *284 + - *287 requestBody: required: false content: @@ -42865,9 +43557,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 '304': *35 '403': *27 '401': *23 @@ -42888,7 +43580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *284 + - *287 responses: '204': description: Response @@ -42926,7 +43618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *284 + - *287 requestBody: required: true content: @@ -43033,7 +43725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &287 + - &290 name: column_id description: The unique identifier of the column. in: path @@ -43045,7 +43737,7 @@ paths: description: Response content: application/json: - schema: &288 + schema: &291 title: Project Column description: Project columns contain cards of work. type: object @@ -43099,7 +43791,7 @@ paths: - created_at - updated_at examples: - default: &289 + default: &292 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -43128,7 +43820,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *287 + - *290 requestBody: required: true content: @@ -43153,9 +43845,9 @@ paths: description: Response content: application/json: - schema: *288 + schema: *291 examples: - default: *289 + default: *292 '304': *35 '403': *27 '401': *23 @@ -43174,7 +43866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *287 + - *290 responses: '204': description: Response @@ -43197,7 +43889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *287 + - *290 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -43218,7 +43910,7 @@ paths: application/json: schema: type: array - items: *285 + items: *288 examples: default: value: @@ -43271,7 +43963,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *287 + - *290 requestBody: required: true content: @@ -43315,9 +44007,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 '304': *35 '403': *27 '401': *23 @@ -43327,8 +44019,8 @@ paths: application/json: schema: oneOf: - - *117 - - *118 + - *120 + - *121 '503': description: Response content: @@ -43367,7 +44059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *287 + - *290 requestBody: required: true content: @@ -43424,15 +44116,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *279 + - *282 responses: '200': description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &290 + default: &293 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -43485,7 +44177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *279 + - *282 requestBody: required: false content: @@ -43534,9 +44226,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *290 + default: *293 '404': description: Not Found if the authenticated user does not have access to the project @@ -43557,7 +44249,7 @@ paths: items: type: string '401': *23 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -43575,7 +44267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *279 + - *282 responses: '204': description: Delete Success @@ -43596,7 +44288,7 @@ paths: items: type: string '401': *23 - '410': *291 + '410': *294 '404': *6 x-github: githubCloudOnly: false @@ -43619,7 +44311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *279 + - *282 - 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 @@ -43646,7 +44338,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -43671,8 +44363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *279 - - *154 + - *282 + - *157 requestBody: required: false content: @@ -43721,8 +44413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *279 - - *154 + - *282 + - *157 responses: '204': description: Response @@ -43750,8 +44442,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *279 - - *154 + - *282 + - *157 responses: '200': description: Response @@ -43815,7 +44507,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *279 + - *282 - *17 - *18 responses: @@ -43825,7 +44517,7 @@ paths: application/json: schema: type: array - items: *288 + items: *291 examples: default: value: @@ -43857,7 +44549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *279 + - *282 requestBody: required: true content: @@ -43881,7 +44573,7 @@ paths: description: Response content: application/json: - schema: *288 + schema: *291 examples: default: value: @@ -43942,7 +44634,7 @@ paths: resources: type: object properties: - core: &292 + core: &295 title: Rate Limit type: object properties: @@ -43959,19 +44651,19 @@ paths: - remaining - reset - used - graphql: *292 - search: *292 - code_search: *292 - source_import: *292 - integration_manifest: *292 - code_scanning_upload: *292 - actions_runner_registration: *292 - scim: *292 - dependency_snapshots: *292 + graphql: *295 + search: *295 + code_search: *295 + source_import: *295 + integration_manifest: *295 + code_scanning_upload: *295 + actions_runner_registration: *295 + scim: *295 + dependency_snapshots: *295 required: - core - search - rate: *292 + rate: *295 required: - rate - resources @@ -44070,14 +44762,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *293 + schema: *296 examples: default-response: summary: Default response @@ -44582,7 +45274,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *294 + '301': *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44600,8 +45292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -44848,10 +45540,10 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 - '307': &296 + default: *298 + '307': &299 description: Temporary Redirect content: application/json: @@ -44880,8 +45572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -44903,7 +45595,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': *296 + '307': *299 '404': *6 x-github: githubCloudOnly: false @@ -44926,11 +45618,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - - &311 + - &314 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -44953,7 +45645,7 @@ paths: type: integer artifacts: type: array - items: &297 + items: &300 title: Artifact description: An artifact type: object @@ -45039,7 +45731,7 @@ paths: - expires_at - updated_at examples: - default: &312 + default: &315 value: total_count: 2 artifacts: @@ -45098,9 +45790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *280 - - *281 - - &298 + - *283 + - *284 + - &301 name: artifact_id description: The unique identifier of the artifact. in: path @@ -45112,7 +45804,7 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: default: value: @@ -45149,9 +45841,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *280 - - *281 - - *298 + - *283 + - *284 + - *301 responses: '204': description: Response @@ -45175,9 +45867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *280 - - *281 - - *298 + - *283 + - *284 + - *301 - name: archive_format in: path required: true @@ -45191,7 +45883,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45214,14 +45906,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *299 + schema: *302 examples: default: value: @@ -45247,11 +45939,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: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - - &300 + - &303 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 @@ -45285,7 +45977,7 @@ paths: description: Response content: application/json: - schema: &301 + schema: &304 title: Repository actions caches description: Repository actions caches type: object @@ -45335,7 +46027,7 @@ paths: - total_count - actions_caches examples: - default: &302 + default: &305 value: total_count: 1 actions_caches: @@ -45367,23 +46059,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: - - *280 - - *281 + - *283 + - *284 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *300 + - *303 responses: '200': description: Response content: application/json: - schema: *301 + schema: *304 examples: - default: *302 + default: *305 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45403,8 +46095,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: - - *280 - - *281 + - *283 + - *284 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -45435,9 +46127,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: - - *280 - - *281 - - &303 + - *283 + - *284 + - &306 name: job_id description: The unique identifier of the job. in: path @@ -45449,7 +46141,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &318 title: Job description: Information of a job execution in a workflow run type: object @@ -45796,9 +46488,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: - - *280 - - *281 - - *303 + - *283 + - *284 + - *306 responses: '302': description: Response @@ -45826,9 +46518,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: - - *280 - - *281 - - *303 + - *283 + - *284 + - *306 requestBody: required: false content: @@ -45850,7 +46542,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -45874,8 +46566,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Status response @@ -45925,8 +46617,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -45960,7 +46652,7 @@ paths: description: Empty response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -45989,8 +46681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -46008,7 +46700,7 @@ paths: type: integer secrets: type: array - items: &317 + items: &320 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -46029,7 +46721,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &321 value: total_count: 2 secrets: @@ -46062,9 +46754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *280 - - *281 - - *304 + - *283 + - *284 + - *307 - *18 responses: '200': @@ -46081,7 +46773,7 @@ paths: type: integer variables: type: array - items: &321 + items: &324 title: Actions Variable type: object properties: @@ -46115,7 +46807,7 @@ paths: - created_at - updated_at examples: - default: &322 + default: &325 value: total_count: 2 variables: @@ -46148,8 +46840,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46158,11 +46850,11 @@ paths: schema: type: object properties: - enabled: &305 + enabled: &308 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *40 - selected_actions_url: *125 + selected_actions_url: *128 required: - enabled examples: @@ -46191,8 +46883,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -46203,7 +46895,7 @@ paths: schema: type: object properties: - enabled: *305 + enabled: *308 allowed_actions: *40 required: - enabled @@ -46234,14 +46926,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &306 + schema: &309 type: object properties: access_level: @@ -46259,7 +46951,7 @@ paths: required: - access_level examples: - default: &307 + default: &310 value: access_level: organization x-github: @@ -46284,15 +46976,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: application/json: - schema: *306 + schema: *309 examples: - default: *307 + default: *310 responses: '204': description: Response @@ -46316,8 +47008,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46348,8 +47040,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -46381,14 +47073,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: default: *46 x-github: @@ -46411,8 +47103,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Success response @@ -46423,7 +47115,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *132 examples: default: *46 x-github: @@ -46452,8 +47144,8 @@ paths: in: query schema: type: string - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -46497,8 +47189,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46506,9 +47198,9 @@ paths: application/json: schema: type: array - items: *133 + items: *136 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46530,8 +47222,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -46574,7 +47266,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *135 + '201': *138 '404': *6 '422': *7 x-github: @@ -46604,8 +47296,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: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -46613,7 +47305,7 @@ paths: application/json: schema: *56 examples: - default: *136 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46641,8 +47333,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: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -46650,7 +47342,7 @@ paths: application/json: schema: *56 examples: - default: *137 + default: *140 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46672,8 +47364,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '200': @@ -46682,7 +47374,7 @@ paths: application/json: schema: *53 examples: - default: *138 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46703,8 +47395,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '204': @@ -46730,8 +47422,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '200': *58 @@ -46756,8 +47448,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: - - *280 - - *281 + - *283 + - *284 - *52 requestBody: required: true @@ -46806,8 +47498,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: - - *280 - - *281 + - *283 + - *284 - *52 requestBody: required: true @@ -46857,11 +47549,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: - '200': *139 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -46888,10 +47580,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: - - *280 - - *281 + - *283 + - *284 - *52 - - *140 + - *143 responses: '200': *58 '404': *6 @@ -46919,9 +47611,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: - - *280 - - *281 - - &325 + - *283 + - *284 + - &328 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. @@ -46929,7 +47621,7 @@ paths: required: false schema: type: string - - &326 + - &329 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -46937,7 +47629,7 @@ paths: required: false schema: type: string - - &327 + - &330 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -46946,7 +47638,7 @@ paths: required: false schema: type: string - - &328 + - &331 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 @@ -46973,7 +47665,7 @@ paths: - pending - *17 - *18 - - &329 + - &332 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)." @@ -46982,7 +47674,7 @@ paths: schema: type: string format: date-time - - &308 + - &311 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -46991,13 +47683,13 @@ paths: schema: type: boolean default: false - - &330 + - &333 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &331 + - &334 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -47020,7 +47712,7 @@ paths: type: integer workflow_runs: type: array - items: &309 + items: &312 title: Workflow Run description: An invocation of a workflow type: object @@ -47137,7 +47829,7 @@ paths: type: - array - 'null' - items: &350 + items: &353 title: Pull Request Minimal type: object properties: @@ -47264,7 +47956,7 @@ paths: head_commit: anyOf: - type: 'null' - - &354 + - &357 title: Simple Commit description: A commit. type: object @@ -47338,8 +48030,8 @@ paths: - timestamp - author - committer - repository: *132 - head_repository: *132 + repository: *135 + head_repository: *135 head_repository_id: type: integer examples: @@ -47379,7 +48071,7 @@ paths: - workflow_url - pull_requests examples: - default: &332 + default: &335 value: total_count: 1 workflow_runs: @@ -47615,24 +48307,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *280 - - *281 - - &310 + - *283 + - *284 + - &313 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *308 + - *311 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &313 + default: &316 value: id: 30433642 name: Build @@ -47873,9 +48565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '204': description: Response @@ -47898,9 +48590,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -48028,15 +48720,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -48063,12 +48755,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 - *17 - *18 - - *311 + - *314 responses: '200': description: Response @@ -48084,9 +48776,9 @@ paths: type: integer artifacts: type: array - items: *297 + items: *300 examples: - default: *312 + default: *315 headers: Link: *37 x-github: @@ -48110,25 +48802,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *280 - - *281 - - *310 - - &314 + - *283 + - *284 + - *313 + - &317 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *308 + - *311 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *313 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48151,10 +48843,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: - - *280 - - *281 - - *310 - - *314 + - *283 + - *284 + - *313 + - *317 - *17 - *18 responses: @@ -48172,9 +48864,9 @@ paths: type: integer jobs: type: array - items: *315 + items: *318 examples: - default: &316 + default: &319 value: total_count: 1 jobs: @@ -48287,10 +48979,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *280 - - *281 - - *310 - - *314 + - *283 + - *284 + - *313 + - *317 responses: '302': description: Response @@ -48318,19 +49010,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '202': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48353,9 +49045,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: true content: @@ -48422,19 +49114,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '202': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48457,9 +49149,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 - 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 @@ -48489,9 +49181,9 @@ paths: type: integer jobs: type: array - items: *315 + items: *318 examples: - default: *316 + default: *319 headers: Link: *37 x-github: @@ -48516,9 +49208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '302': description: Response @@ -48545,9 +49237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '204': description: Response @@ -48574,9 +49266,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -48645,7 +49337,7 @@ paths: items: type: object properties: - type: &422 + type: &425 type: string description: The type of reviewer. enum: @@ -48656,7 +49348,7 @@ paths: reviewer: anyOf: - *4 - - *198 + - *201 required: - environment - wait_timer @@ -48731,9 +49423,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: true content: @@ -48783,7 +49475,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -48895,7 +49587,7 @@ paths: - created_at - updated_at examples: - default: &418 + default: &421 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -48951,9 +49643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: false content: @@ -48975,7 +49667,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -48998,9 +49690,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: false content: @@ -49022,7 +49714,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49047,9 +49739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -49186,8 +49878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -49205,9 +49897,9 @@ paths: type: integer secrets: type: array - items: *317 + items: *320 examples: - default: *318 + default: *321 headers: Link: *37 x-github: @@ -49232,16 +49924,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *320 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49263,17 +49955,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *317 + schema: *320 examples: - default: &435 + default: &438 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -49299,9 +49991,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -49329,7 +50021,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49355,9 +50047,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -49382,9 +50074,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *280 - - *281 - - *304 + - *283 + - *284 + - *307 - *18 responses: '200': @@ -49401,9 +50093,9 @@ paths: type: integer variables: type: array - items: *321 + items: *324 examples: - default: *322 + default: *325 headers: Link: *37 x-github: @@ -49426,8 +50118,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -49454,7 +50146,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49479,17 +50171,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: &436 + default: &439 value: name: USERNAME value: octocat @@ -49515,9 +50207,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 requestBody: required: true content: @@ -49559,9 +50251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 responses: '204': description: Response @@ -49586,8 +50278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -49605,7 +50297,7 @@ paths: type: integer workflows: type: array - items: &323 + items: &326 title: Workflow description: A GitHub Actions workflow type: object @@ -49723,9 +50415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *280 - - *281 - - &324 + - *283 + - *284 + - &327 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -49740,7 +50432,7 @@ paths: description: Response content: application/json: - schema: *323 + schema: *326 examples: default: value: @@ -49773,9 +50465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49800,9 +50492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49853,9 +50545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49880,19 +50572,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: - - *280 - - *281 - - *324 - - *325 - - *326 + - *283 + - *284 - *327 - *328 - - *17 - - *18 - *329 - - *308 - *330 - *331 + - *17 + - *18 + - *332 + - *311 + - *333 + - *334 responses: '200': description: Response @@ -49908,9 +50600,9 @@ paths: type: integer workflow_runs: type: array - items: *309 + items: *312 examples: - default: *332 + default: *335 headers: Link: *37 x-github: @@ -49936,9 +50628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '200': description: Response @@ -49999,8 +50691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *280 - - *281 + - *283 + - *284 - *65 - *17 - *63 @@ -50168,8 +50860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -50181,7 +50873,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -50206,8 +50898,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: - - *280 - - *281 + - *283 + - *284 - name: assignee in: path required: true @@ -50243,8 +50935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -50356,8 +51048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *63 - *64 @@ -50401,7 +51093,7 @@ paths: repository_id: type: integer examples: - default: *333 + default: *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50421,8 +51113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -50430,7 +51122,7 @@ paths: application/json: schema: type: array - items: &334 + items: &337 title: Autolink reference description: An autolink reference. type: object @@ -50484,8 +51176,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -50524,9 +51216,9 @@ paths: description: response content: application/json: - schema: *334 + schema: *337 examples: - default: &335 + default: &338 value: id: 1 key_prefix: TICKET- @@ -50557,9 +51249,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: - - *280 - - *281 - - &336 + - *283 + - *284 + - &339 name: autolink_id description: The unique identifier of the autolink. in: path @@ -50571,9 +51263,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *337 examples: - default: *335 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -50593,9 +51285,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: - - *280 - - *281 - - *336 + - *283 + - *284 + - *339 responses: '204': description: Response @@ -50619,8 +51311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response if Dependabot is enabled @@ -50670,8 +51362,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -50692,8 +51384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -50713,8 +51405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *280 - - *281 + - *283 + - *284 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -50752,7 +51444,7 @@ paths: - url protected: type: boolean - protection: &338 + protection: &341 title: Branch Protection description: Branch Protection type: object @@ -50795,7 +51487,7 @@ paths: required: - contexts - checks - enforce_admins: &341 + enforce_admins: &344 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -50812,7 +51504,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &343 + required_pull_request_reviews: &346 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -50834,7 +51526,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *198 + items: *201 apps: description: The list of apps with review dismissal access. @@ -50866,7 +51558,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *198 + items: *201 apps: description: The list of apps allowed to bypass pull request requirements. @@ -50896,7 +51588,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &340 + restrictions: &343 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -51221,9 +51913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *280 - - *281 - - &339 + - *283 + - *284 + - &342 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). @@ -51237,14 +51929,14 @@ paths: description: Response content: application/json: - schema: &349 + schema: &352 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &393 + commit: &396 title: Commit description: Commit type: object @@ -51283,7 +51975,7 @@ paths: author: anyOf: - type: 'null' - - &337 + - &340 title: Git User description: Metaproperties for Git author/committer information. @@ -51304,7 +51996,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 message: type: string examples: @@ -51328,7 +52020,7 @@ paths: required: - sha - url - verification: &442 + verification: &445 title: Verification type: object properties: @@ -51359,14 +52051,14 @@ paths: author: oneOf: - *4 - - *143 + - *146 type: - 'null' - object committer: oneOf: - *4 - - *143 + - *146 type: - 'null' - object @@ -51403,7 +52095,7 @@ paths: type: integer files: type: array - items: &405 + items: &408 title: Diff Entry description: Diff Entry type: object @@ -51497,7 +52189,7 @@ paths: - self protected: type: boolean - protection: *338 + protection: *341 protection_url: type: string format: uri @@ -51605,7 +52297,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *294 + '301': *297 '404': *6 x-github: githubCloudOnly: false @@ -51627,15 +52319,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *338 + schema: *341 examples: default: value: @@ -51829,9 +52521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -52091,7 +52783,7 @@ paths: url: type: string format: uri - required_status_checks: &346 + required_status_checks: &349 title: Status Check Policy description: Status Check Policy type: object @@ -52172,7 +52864,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 apps: type: array items: *5 @@ -52190,7 +52882,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 apps: type: array items: *5 @@ -52250,7 +52942,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *340 + restrictions: *343 required_conversation_resolution: type: object properties: @@ -52362,9 +53054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52389,17 +53081,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: &342 + default: &345 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -52421,17 +53113,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: *342 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52450,9 +53142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52477,17 +53169,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *343 + schema: *346 examples: - default: &344 + default: &347 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -52583,9 +53275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -52683,9 +53375,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *346 examples: - default: *344 + default: *347 '422': *15 x-github: githubCloudOnly: false @@ -52706,9 +53398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52735,17 +53427,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: &345 + default: &348 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -52768,17 +53460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: *345 + default: *348 '404': *6 x-github: githubCloudOnly: false @@ -52798,9 +53490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52825,17 +53517,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: &347 + default: &350 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -52861,9 +53553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -52915,9 +53607,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 '404': *6 '422': *15 x-github: @@ -52939,9 +53631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52965,9 +53657,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53001,9 +53693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53070,9 +53762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53136,9 +53828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: content: application/json: @@ -53204,15 +53896,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *340 + schema: *343 examples: default: value: @@ -53303,9 +53995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -53328,9 +54020,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53340,7 +54032,7 @@ paths: type: array items: *5 examples: - default: &348 + default: &351 value: - id: 1 slug: octoapp @@ -53397,9 +54089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53433,7 +54125,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53454,9 +54146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53490,7 +54182,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53511,9 +54203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53547,7 +54239,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53569,9 +54261,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53579,9 +54271,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '404': *6 x-github: githubCloudOnly: false @@ -53601,9 +54293,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53639,9 +54331,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53662,9 +54354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53700,9 +54392,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53723,9 +54415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: content: application/json: @@ -53760,9 +54452,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53784,9 +54476,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53796,7 +54488,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '404': *6 x-github: githubCloudOnly: false @@ -53820,9 +54512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53855,7 +54547,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53880,9 +54572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53915,7 +54607,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53940,9 +54632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53975,7 +54667,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -54002,9 +54694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -54026,7 +54718,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *352 examples: default: value: @@ -54141,8 +54833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -54421,7 +55113,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &354 title: CheckRun description: A check performed on the code of a given code change type: object @@ -54556,8 +55248,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *350 - deployment: &651 + items: *353 + deployment: &654 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -54844,9 +55536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *280 - - *281 - - &352 + - *283 + - *284 + - &355 name: check_run_id description: The unique identifier of the check run. in: path @@ -54858,9 +55550,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: &353 + default: &356 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -54960,9 +55652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 requestBody: required: true content: @@ -55202,9 +55894,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: *353 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55224,9 +55916,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 - *17 - *18 responses: @@ -55338,15 +56030,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -55384,8 +56076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -55407,7 +56099,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &355 + schema: &358 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -55488,12 +56180,12 @@ paths: type: - array - 'null' - items: *350 + items: *353 app: anyOf: - type: 'null' - *5 - repository: *132 + repository: *135 created_at: type: - string @@ -55504,7 +56196,7 @@ paths: - string - 'null' format: date-time - head_commit: *354 + head_commit: *357 latest_check_runs_count: type: integer check_runs_url: @@ -55532,7 +56224,7 @@ paths: - check_runs_url - pull_requests examples: - default: &356 + default: &359 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -55823,9 +56515,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55844,8 +56536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -55906,7 +56598,7 @@ paths: required: - app_id - setting - repository: *132 + repository: *135 examples: default: value: @@ -56154,9 +56846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *280 - - *281 - - &357 + - *283 + - *284 + - &360 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -56168,9 +56860,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56193,17 +56885,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: - - *280 - - *281 - - *357 - - &400 + - *283 + - *284 + - *360 + - &403 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &401 + - &404 name: status description: Returns check runs with the specified `status`. in: query @@ -56242,9 +56934,9 @@ paths: type: integer check_runs: type: array - items: *351 + items: *354 examples: - default: &402 + default: &405 value: total_count: 1 check_runs: @@ -56346,15 +57038,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *280 - - *281 - - *357 + - *283 + - *284 + - *360 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -56381,21 +57073,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: - - *280 - - *281 - - *155 - - *156 + - *283 + - *284 + - *158 + - *159 - *18 - *17 - - &369 + - &372 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: *358 - - &370 + schema: *361 + - &373 name: pr description: The number of the pull request for the results you want to list. in: query @@ -56420,13 +57112,13 @@ paths: be returned. in: query required: false - schema: *157 + schema: *160 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *359 + schema: *362 responses: '200': description: Response @@ -56442,7 +57134,7 @@ paths: updated_at: *77 url: *74 html_url: *75 - instances_url: *360 + instances_url: *363 state: *68 fixed_at: *79 dismissed_by: @@ -56450,11 +57142,11 @@ paths: - type: 'null' - *4 dismissed_at: *78 - dismissed_reason: *361 - dismissed_comment: *362 - rule: *363 - tool: *364 - most_recent_instance: *365 + dismissed_reason: *364 + dismissed_comment: *365 + rule: *366 + tool: *367 + most_recent_instance: *368 required: - number - created_at @@ -56570,7 +57262,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &366 + '403': &369 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -56597,9 +57289,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: - - *280 - - *281 - - &367 + - *283 + - *284 + - &370 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -56613,7 +57305,7 @@ paths: description: Response content: application/json: - schema: &368 + schema: &371 type: object properties: number: *70 @@ -56621,7 +57313,7 @@ paths: updated_at: *77 url: *74 html_url: *75 - instances_url: *360 + instances_url: *363 state: *68 fixed_at: *79 dismissed_by: @@ -56629,8 +57321,8 @@ paths: - type: 'null' - *4 dismissed_at: *78 - dismissed_reason: *361 - dismissed_comment: *362 + dismissed_reason: *364 + dismissed_comment: *365 rule: type: object properties: @@ -56692,8 +57384,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *364 - most_recent_instance: *365 + tool: *367 + most_recent_instance: *368 required: - number - created_at @@ -56782,7 +57474,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -56802,9 +57494,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 requestBody: required: true content: @@ -56819,8 +57511,8 @@ paths: enum: - open - dismissed - dismissed_reason: *361 - dismissed_comment: *362 + dismissed_reason: *364 + dismissed_comment: *365 required: - state examples: @@ -56835,7 +57527,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *371 examples: default: value: @@ -56910,7 +57602,7 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &375 + '403': &378 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -56937,13 +57629,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 - *18 - *17 - - *369 - - *370 + - *372 + - *373 responses: '200': description: Response @@ -56951,7 +57643,7 @@ paths: application/json: schema: type: array - items: *365 + items: *368 examples: default: value: @@ -56990,7 +57682,7 @@ paths: end_column: 50 classifications: - source - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57024,25 +57716,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: - - *280 - - *281 - - *155 - - *156 + - *283 + - *284 + - *158 + - *159 - *18 - *17 - - *370 + - *373 - 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: *358 + schema: *361 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &373 + schema: &376 type: string description: An identifier for the upload. examples: @@ -57064,23 +57756,23 @@ paths: application/json: schema: type: array - items: &374 + items: &377 type: object properties: - ref: *358 - commit_sha: &383 + ref: *361 + commit_sha: &386 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: *371 + analysis_key: *374 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *372 + category: *375 error: type: string examples: @@ -57105,8 +57797,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *373 - tool: *364 + sarif_id: *376 + tool: *367 deletable: type: boolean warning: @@ -57168,7 +57860,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57204,8 +57896,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: - - *280 - - *281 + - *283 + - *284 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57218,7 +57910,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *377 examples: response: summary: application/json response @@ -57272,7 +57964,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57354,8 +58046,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: - - *280 - - *281 + - *283 + - *284 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57411,7 +58103,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': *375 + '403': *378 '404': *6 '503': *81 x-github: @@ -57433,8 +58125,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -57442,7 +58134,7 @@ paths: application/json: schema: type: array - items: &376 + items: &379 title: CodeQL Database description: A CodeQL database. type: object @@ -57554,7 +58246,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': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57583,8 +58275,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: - - *280 - - *281 + - *283 + - *284 - name: language in: path description: The language of the CodeQL database. @@ -57596,7 +58288,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: default: value: @@ -57628,9 +58320,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': &407 + '302': &410 description: Found - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57658,8 +58350,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -57668,7 +58360,7 @@ paths: type: object additionalProperties: false properties: - language: &377 + language: &380 type: string description: The language targeted by the CodeQL query enum: @@ -57746,7 +58438,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &381 + schema: &384 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -57756,7 +58448,7 @@ paths: description: The ID of the variant analysis. controller_repo: *80 actor: *4 - query_language: *377 + query_language: *380 query_pack_url: type: string description: The download url for the query pack. @@ -57804,7 +58496,7 @@ paths: items: type: object properties: - repository: &378 + repository: &381 title: Repository Identifier description: Repository Identifier type: object @@ -57846,7 +58538,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &382 + analysis_status: &385 type: string description: The new status of the CodeQL variant analysis repository task. @@ -57878,7 +58570,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &379 + access_mismatch_repos: &382 type: object properties: repository_count: @@ -57893,7 +58585,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: *378 + items: *381 required: - repository_count - repositories @@ -57916,8 +58608,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *379 - over_limit_repos: *379 + no_codeql_db_repos: *382 + over_limit_repos: *382 required: - access_mismatch_repos - not_found_repos @@ -57933,7 +58625,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &380 + value: &383 summary: Default response value: id: 1 @@ -58085,10 +58777,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *380 + value: *383 repository_lists: summary: Response for a successful variant analysis submission - value: *380 + value: *383 '404': *6 '422': description: Unable to process variant analysis submission @@ -58116,8 +58808,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: - - *280 - - *281 + - *283 + - *284 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -58129,9 +58821,9 @@ paths: description: Response content: application/json: - schema: *381 + schema: *384 examples: - default: *380 + default: *383 '404': *6 '503': *81 x-github: @@ -58154,7 +58846,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: - - *280 + - *283 - name: repo in: path description: The name of the controller repository. @@ -58189,7 +58881,7 @@ paths: type: object properties: repository: *80 - analysis_status: *382 + analysis_status: *385 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -58314,8 +59006,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58380,7 +59072,7 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -58401,8 +59093,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -58447,7 +59139,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -58472,7 +59164,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *375 + '403': *378 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -58537,8 +59229,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -58546,7 +59238,7 @@ paths: schema: type: object properties: - commit_sha: *383 + commit_sha: *386 ref: type: string description: |- @@ -58606,7 +59298,7 @@ paths: schema: type: object properties: - id: *373 + id: *376 url: type: string description: The REST API URL for checking the status of the upload. @@ -58620,7 +59312,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': *375 + '403': *378 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -58643,8 +59335,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: - - *280 - - *281 + - *283 + - *284 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -58692,7 +59384,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': *366 + '403': *369 '404': description: Not Found if the sarif id does not match any upload '503': *81 @@ -58717,8 +59409,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58742,7 +59434,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *160 + configuration: *163 examples: default: value: @@ -58771,7 +59463,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': *163 + '204': *166 '304': *35 '403': *27 '404': *6 @@ -58796,8 +59488,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *280 - - *281 + - *283 + - *284 - 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 @@ -58925,8 +59617,8 @@ paths: parameters: - *17 - *18 - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58942,7 +59634,7 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: default: value: @@ -59240,8 +59932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -59305,17 +59997,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '400': *14 '401': *23 '403': *27 @@ -59344,8 +60036,8 @@ paths: parameters: - *17 - *18 - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -59409,8 +60101,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: - - *280 - - *281 + - *283 + - *284 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -59447,9 +60139,9 @@ paths: type: integer machines: type: array - items: *385 + items: *388 examples: - default: &608 + default: &611 value: total_count: 2 machines: @@ -59489,8 +60181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *280 - - *281 + - *283 + - *284 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -59577,8 +60269,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: - - *280 - - *281 + - *283 + - *284 - 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 @@ -59647,8 +60339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -59666,7 +60358,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &392 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -59687,7 +60379,7 @@ paths: - created_at - updated_at examples: - default: *386 + default: *389 headers: Link: *37 x-github: @@ -59710,16 +60402,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59739,17 +60431,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *389 + schema: *392 examples: - default: *390 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59769,9 +60461,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: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -59799,7 +60491,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -59823,9 +60515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -59853,8 +60545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *280 - - *281 + - *283 + - *284 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -59892,7 +60584,7 @@ paths: application/json: schema: type: array - items: &391 + items: &394 title: Collaborator description: Collaborator type: object @@ -60085,9 +60777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '204': description: Response if user is a collaborator @@ -60129,9 +60821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 requestBody: required: false content: @@ -60157,7 +60849,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &455 + schema: &458 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -60169,7 +60861,7 @@ paths: format: int64 examples: - 42 - repository: *132 + repository: *135 invitee: anyOf: - type: 'null' @@ -60378,9 +61070,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '204': description: No Content when collaborator was removed from the repository. @@ -60409,9 +61101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '200': description: if user has admin permissions @@ -60431,7 +61123,7 @@ paths: user: anyOf: - type: 'null' - - *391 + - *394 required: - permission - role_name @@ -60485,8 +61177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -60496,7 +61188,7 @@ paths: application/json: schema: type: array - items: &392 + items: &395 title: Commit Comment description: Commit Comment type: object @@ -60537,8 +61229,8 @@ paths: updated_at: type: string format: date-time - author_association: *85 - reactions: *86 + author_association: *88 + reactions: *89 required: - url - html_url @@ -60554,7 +61246,7 @@ paths: - created_at - updated_at examples: - default: &395 + default: &398 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60613,17 +61305,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *392 + schema: *395 examples: - default: &396 + default: &399 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60680,9 +61372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -60704,7 +61396,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *395 examples: default: value: @@ -60755,9 +61447,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -60778,9 +61470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -60806,9 +61498,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -60829,9 +61521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -60863,16 +61555,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -60894,10 +61586,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -60945,8 +61637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *280 - - *281 + - *283 + - *284 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -61002,9 +61694,9 @@ paths: application/json: schema: type: array - items: *393 + items: *396 examples: - default: &502 + default: &505 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61077,7 +61769,7 @@ paths: '500': *69 '400': *14 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61097,9 +61789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *280 - - *281 - - &394 + - *283 + - *284 + - &397 name: commit_sha description: The SHA of the commit. in: path @@ -61146,7 +61838,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61171,9 +61863,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 - *17 - *18 responses: @@ -61183,9 +61875,9 @@ paths: application/json: schema: type: array - items: *392 + items: *395 examples: - default: *395 + default: *398 headers: Link: *37 x-github: @@ -61213,9 +61905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 requestBody: required: true content: @@ -61250,9 +61942,9 @@ paths: description: Response content: application/json: - schema: *392 + schema: *395 examples: - default: *396 + default: *399 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61280,9 +61972,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: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 - *17 - *18 responses: @@ -61292,7 +61984,7 @@ paths: application/json: schema: type: array - items: &493 + items: &496 title: Pull Request Simple description: Pull Request Simple type: object @@ -61412,7 +62104,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 active_lock_reason: type: - string @@ -61467,7 +62159,7 @@ paths: type: - array - 'null' - items: *198 + items: *201 head: type: object properties: @@ -61511,7 +62203,7 @@ paths: _links: type: object properties: - comments: &398 + comments: &401 title: Link description: Hypermedia Link type: object @@ -61520,13 +62212,13 @@ paths: type: string required: - href - commits: *398 - statuses: *398 - html: *398 - issue: *398 - review_comments: *398 - review_comment: *398 - self: *398 + commits: *401 + statuses: *401 + html: *401 + issue: *401 + review_comments: *401 + review_comment: *401 + self: *401 required: - comments - commits @@ -61536,8 +62228,8 @@ paths: - review_comments - review_comment - self - author_association: *85 - auto_merge: &495 + author_association: *88 + auto_merge: &498 title: Auto merge description: The status of auto merging a pull request. type: @@ -61602,7 +62294,7 @@ paths: - author_association - auto_merge examples: - default: &494 + default: &497 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -62082,7 +62774,7 @@ paths: draft: false headers: Link: *37 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62138,11 +62830,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 - - &399 + - &402 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)" @@ -62157,9 +62849,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *396 examples: - default: &481 + default: &484 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -62246,7 +62938,7 @@ paths: '404': *6 '500': *69 '503': *81 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62271,11 +62963,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: - - *280 - - *281 - - *399 - - *400 - - *401 + - *283 + - *284 + - *402 + - *403 + - *404 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -62309,9 +63001,9 @@ paths: type: integer check_runs: type: array - items: *351 + items: *354 examples: - default: *402 + default: *405 headers: Link: *37 x-github: @@ -62336,9 +63028,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: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -62346,7 +63038,7 @@ paths: schema: type: integer example: 1 - - *400 + - *403 - *17 - *18 responses: @@ -62364,7 +63056,7 @@ paths: type: integer check_suites: type: array - items: *355 + items: *358 examples: default: value: @@ -62564,9 +63256,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: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - *17 - *18 responses: @@ -62637,7 +63329,7 @@ paths: type: string total_count: type: integer - repository: *132 + repository: *135 commit_url: type: string format: uri @@ -62768,9 +63460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - *17 - *18 responses: @@ -62780,7 +63472,7 @@ paths: application/json: schema: type: array - items: &556 + items: &559 title: Status description: The status of a commit. type: object @@ -62861,7 +63553,7 @@ paths: site_admin: false headers: Link: *37 - '301': *294 + '301': *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62889,8 +63581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -62923,11 +63615,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *403 + - *406 code_of_conduct_file: anyOf: - type: 'null' - - &404 + - &407 title: Community Health File type: object properties: @@ -62943,23 +63635,23 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 contributing: anyOf: - type: 'null' - - *404 + - *407 readme: anyOf: - type: 'null' - - *404 + - *407 issue_template: anyOf: - type: 'null' - - *404 + - *407 pull_request_template: anyOf: - type: 'null' - - *404 + - *407 required: - code_of_conduct - code_of_conduct_file @@ -63087,8 +63779,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 - name: basehead @@ -63136,8 +63828,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *393 - merge_base_commit: *393 + base_commit: *396 + merge_base_commit: *396 status: type: string enum: @@ -63161,10 +63853,10 @@ paths: - 6 commits: type: array - items: *393 + items: *396 files: type: array - items: *405 + items: *408 required: - url - html_url @@ -63447,8 +64139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -63599,7 +64291,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &406 + response-if-content-is-a-file: &409 summary: Response if content is a file value: type: file @@ -63736,7 +64428,7 @@ paths: - size - type - url - - &507 + - &510 title: Content File description: Content File type: object @@ -63954,7 +64646,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *406 + response-if-content-is-a-file: *409 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -64023,7 +64715,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *407 + '302': *410 '304': *35 x-github: githubCloudOnly: false @@ -64046,8 +64738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -64142,7 +64834,7 @@ paths: description: Response content: application/json: - schema: &408 + schema: &411 title: File Commit description: File Commit type: object @@ -64293,7 +64985,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: example-for-creating-a-file: value: @@ -64346,7 +65038,7 @@ paths: schema: oneOf: - *3 - - &437 + - &440 description: Repository rule violation was detected type: object properties: @@ -64367,7 +65059,7 @@ paths: items: type: object properties: - placeholder_id: &549 + placeholder_id: &552 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -64399,8 +65091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -64461,7 +65153,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: default: value: @@ -64494,7 +65186,7 @@ paths: payload: '422': *15 '404': *6 - '409': *119 + '409': *122 '503': *81 x-github: githubCloudOnly: false @@ -64515,8 +65207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *280 - - *281 + - *283 + - *284 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -64640,20 +65332,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *280 - - *281 - - *173 - - *174 - - *175 + - *283 + - *284 - *176 + - *177 + - *178 + - *179 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *177 - - *178 + - *180 + - *181 - *65 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64673,8 +65365,8 @@ paths: default: 30 - *63 - *64 - - *179 - - *180 + - *182 + - *183 responses: '200': description: Response @@ -64682,7 +65374,7 @@ paths: application/json: schema: type: array - items: &411 + items: &414 type: object description: A Dependabot alert. properties: @@ -64717,7 +65409,7 @@ paths: - development - runtime - - security_advisory: *409 + security_advisory: *412 security_vulnerability: *73 url: *74 html_url: *75 @@ -64748,7 +65440,7 @@ paths: dismissal. maxLength: 280 fixed_at: *79 - auto_dismissed_at: *410 + auto_dismissed_at: *413 required: - number - state @@ -64975,9 +65667,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *280 - - *281 - - &412 + - *283 + - *284 + - &415 name: alert_number in: path description: |- @@ -64992,7 +65684,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *414 examples: default: value: @@ -65102,9 +65794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *280 - - *281 - - *412 + - *283 + - *284 + - *415 requestBody: required: true content: @@ -65149,7 +65841,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *414 examples: default: value: @@ -65255,7 +65947,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 '422': *7 x-github: githubCloudOnly: false @@ -65278,8 +65970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -65297,7 +65989,7 @@ paths: type: integer secrets: type: array - items: &415 + items: &418 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -65351,16 +66043,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *413 + schema: *416 examples: - default: *414 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65380,15 +66072,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: default: value: @@ -65414,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -65444,7 +66136,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -65468,9 +66160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -65492,8 +66184,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: - - *280 - - *281 + - *283 + - *284 - 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 @@ -65667,8 +66359,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -65891,8 +66583,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -65975,7 +66667,7 @@ paths: - version - url additionalProperties: false - metadata: &416 + metadata: &419 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -66014,7 +66706,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *416 + metadata: *419 resolved: type: object description: A collection of resolved package dependencies. @@ -66028,7 +66720,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *416 + metadata: *419 relationship: type: string description: A notation of whether a dependency is requested @@ -66161,8 +66853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *280 - - *281 + - *283 + - *284 - name: sha description: The SHA recorded at creation time. in: query @@ -66203,9 +66895,9 @@ paths: application/json: schema: type: array - items: *417 + items: *420 examples: - default: *418 + default: *421 headers: Link: *37 x-github: @@ -66271,8 +66963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -66354,7 +67046,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: simple-example: summary: Simple example @@ -66427,9 +67119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *280 - - *281 - - &419 + - *283 + - *284 + - &422 name: deployment_id description: deployment_id parameter in: path @@ -66441,7 +67133,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: default: value: @@ -66506,9 +67198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 responses: '204': description: Response @@ -66530,9 +67222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 - *17 - *18 responses: @@ -66542,7 +67234,7 @@ paths: application/json: schema: type: array - items: &420 + items: &423 title: Deployment Status description: The status of a deployment. type: object @@ -66706,9 +67398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 requestBody: required: true content: @@ -66783,9 +67475,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: &421 + default: &424 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -66841,9 +67533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 - name: status_id in: path required: true @@ -66854,9 +67546,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: *421 + default: *424 '404': *6 x-github: githubCloudOnly: false @@ -66881,8 +67573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -66939,8 +67631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -66958,7 +67650,7 @@ paths: - 5 environments: type: array - items: &423 + items: &426 title: Environment description: Details of a deployment environment type: object @@ -67020,7 +67712,7 @@ paths: type: string examples: - wait_timer - wait_timer: &425 + wait_timer: &428 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -67062,11 +67754,11 @@ paths: items: type: object properties: - type: *422 + type: *425 reviewer: anyOf: - *4 - - *198 + - *201 required: - id - node_id @@ -67089,7 +67781,7 @@ paths: - id - node_id - type - deployment_branch_policy: &426 + deployment_branch_policy: &429 type: - object - 'null' @@ -67206,9 +67898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *280 - - *281 - - &424 + - *283 + - *284 + - &427 name: environment_name in: path required: true @@ -67221,9 +67913,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: &427 + default: &430 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -67307,9 +67999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: false content: @@ -67319,7 +68011,7 @@ paths: - object - 'null' properties: - wait_timer: *425 + wait_timer: *428 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -67338,14 +68030,14 @@ paths: items: type: object properties: - type: *422 + type: *425 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *426 + deployment_branch_policy: *429 additionalProperties: false examples: default: @@ -67365,9 +68057,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *427 + default: *430 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -67391,9 +68083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 responses: '204': description: Default response @@ -67418,9 +68110,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 - *17 - *18 responses: @@ -67439,7 +68131,7 @@ paths: - 2 branch_policies: type: array - items: &428 + items: &431 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -67500,9 +68192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: true content: @@ -67550,9 +68242,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - example-wildcard: &429 + example-wildcard: &432 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -67594,10 +68286,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - &430 + - *283 + - *284 + - *427 + - &433 name: branch_policy_id in: path required: true @@ -67609,9 +68301,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67630,10 +68322,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - *430 + - *283 + - *284 + - *427 + - *433 requestBody: required: true content: @@ -67662,9 +68354,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67683,10 +68375,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - *430 + - *283 + - *284 + - *427 + - *433 responses: '204': description: Response @@ -67711,9 +68403,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 responses: '200': description: List of deployment protection rules @@ -67730,7 +68422,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &431 + items: &434 title: Deployment protection rule description: Deployment protection rule type: object @@ -67752,7 +68444,7 @@ paths: for the environment. examples: - true - app: &432 + app: &435 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -67855,9 +68547,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 requestBody: content: application/json: @@ -67878,9 +68570,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *431 + schema: *434 examples: - default: &433 + default: &436 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -67915,9 +68607,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 - *18 - *17 responses: @@ -67937,7 +68629,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *432 + items: *435 examples: default: value: @@ -67972,10 +68664,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: - - *280 - - *281 - - *424 - - &434 + - *283 + - *284 + - *427 + - &437 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -67987,9 +68679,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *433 + default: *436 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68010,10 +68702,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: - - *424 - - *281 - - *280 - - *434 + - *427 + - *284 + - *283 + - *437 responses: '204': description: Response @@ -68039,9 +68731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 - *17 - *18 responses: @@ -68059,9 +68751,9 @@ paths: type: integer secrets: type: array - items: *317 + items: *320 examples: - default: *318 + default: *321 headers: Link: *37 x-github: @@ -68086,17 +68778,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 responses: '200': description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *320 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68118,18 +68810,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 responses: '200': description: Response content: application/json: - schema: *317 + schema: *320 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68151,10 +68843,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 requestBody: required: true content: @@ -68185,7 +68877,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -68211,10 +68903,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 responses: '204': description: Default response @@ -68239,10 +68931,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *280 - - *281 - - *424 - - *304 + - *283 + - *284 + - *427 + - *307 - *18 responses: '200': @@ -68259,9 +68951,9 @@ paths: type: integer variables: type: array - items: *321 + items: *324 examples: - default: *322 + default: *325 headers: Link: *37 x-github: @@ -68284,9 +68976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: true content: @@ -68313,7 +69005,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -68338,18 +69030,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *280 - - *281 - - *424 - - *145 + - *283 + - *284 + - *427 + - *148 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: *436 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68370,10 +69062,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *280 - - *281 - - *145 - - *424 + - *283 + - *284 + - *148 + - *427 requestBody: required: true content: @@ -68415,10 +69107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *280 - - *281 - - *145 - - *424 + - *283 + - *284 + - *148 + - *427 responses: '204': description: Response @@ -68440,8 +69132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -68451,7 +69143,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: 200-response: value: @@ -68518,8 +69210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *280 - - *281 + - *283 + - *284 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -68541,7 +69233,7 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: default: value: @@ -68678,8 +69370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -68712,9 +69404,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 '400': *14 '422': *15 '403': *27 @@ -68735,8 +69427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -68787,7 +69479,7 @@ paths: schema: type: string '404': *6 - '409': *119 + '409': *122 '403': *27 '422': description: Validation failed @@ -68795,8 +69487,8 @@ paths: application/json: schema: oneOf: - - *117 - - *437 + - *120 + - *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68821,8 +69513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *280 - - *281 + - *283 + - *284 - name: file_sha in: path required: true @@ -68874,7 +69566,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68921,8 +69613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69031,7 +69723,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &441 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -69202,7 +69894,7 @@ paths: type: string '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69251,15 +69943,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 responses: '200': description: Response content: application/json: - schema: *438 + schema: *441 examples: default: value: @@ -69289,7 +69981,7 @@ paths: signature: payload: '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69314,9 +70006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *280 - - *281 - - &439 + - *283 + - *284 + - &442 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. @@ -69333,7 +70025,7 @@ paths: application/json: schema: type: array - items: &440 + items: &443 title: Git Reference description: Git references within a repository type: object @@ -69388,7 +70080,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69409,17 +70101,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 responses: '200': description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: &441 + default: &444 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -69429,7 +70121,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69448,8 +70140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69478,16 +70170,16 @@ paths: description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: *441 + default: *444 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69506,9 +70198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 requestBody: required: true content: @@ -69537,11 +70229,11 @@ paths: description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: *441 + default: *444 '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69557,14 +70249,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 responses: '204': description: Response '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69611,8 +70303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69679,7 +70371,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &446 title: Git Tag description: Metadata for a Git tag type: object @@ -69735,7 +70427,7 @@ paths: - sha - type - url - verification: *442 + verification: *445 required: - sha - url @@ -69745,7 +70437,7 @@ paths: - tag - message examples: - default: &444 + default: &447 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -69771,7 +70463,7 @@ paths: schema: type: string '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69816,8 +70508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *280 - - *281 + - *283 + - *284 - name: tag_sha in: path required: true @@ -69828,11 +70520,11 @@ paths: description: Response content: application/json: - schema: *443 + schema: *446 examples: - default: *444 + default: *447 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69854,8 +70546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69929,7 +70621,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &448 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -70024,7 +70716,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70047,8 +70739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *280 - - *281 + - *283 + - *284 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -70071,7 +70763,7 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: default-response: summary: Default response @@ -70112,7 +70804,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70130,8 +70822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -70141,7 +70833,7 @@ paths: application/json: schema: type: array - items: &446 + items: &449 title: Webhook description: Webhooks for repositories. type: object @@ -70204,7 +70896,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &682 + last_response: &685 title: Hook Response type: object properties: @@ -70281,8 +70973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -70335,9 +71027,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: &447 + default: &450 value: type: Repository id: 12345678 @@ -70385,17 +71077,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '200': description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 '404': *6 x-github: githubCloudOnly: false @@ -70415,9 +71107,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 requestBody: required: true content: @@ -70462,9 +71154,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 '422': *15 '404': *6 x-github: @@ -70482,9 +71174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70508,9 +71200,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '200': description: Response @@ -70537,9 +71229,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 requestBody: required: false content: @@ -70583,11 +71275,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *17 - - *187 + - *190 - name: redelivery in: query required: false @@ -70600,9 +71292,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '400': *14 '422': *15 x-github: @@ -70621,18 +71313,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: - default: *191 + default: *194 '400': *14 '422': *15 x-github: @@ -70651,12 +71343,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *16 responses: - '202': *120 + '202': *123 '400': *14 '422': *15 x-github: @@ -70676,9 +71368,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70703,9 +71395,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70763,14 +71455,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &448 + schema: &451 title: Import description: A repository import from an external source. type: object @@ -70877,7 +71569,7 @@ paths: - html_url - authors_url examples: - default: &451 + default: &454 value: vcs: subversion use_lfs: true @@ -70893,7 +71585,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': &449 + '503': &452 description: Unavailable due to service under maintenance. content: application/json: @@ -70922,8 +71614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -70971,7 +71663,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: default: value: @@ -70996,7 +71688,7 @@ paths: type: string '422': *15 '404': *6 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71024,8 +71716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -71077,7 +71769,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: example-1: summary: Example 1 @@ -71125,7 +71817,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': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71148,12 +71840,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71179,9 +71871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *280 - - *281 - - &631 + - *283 + - *284 + - &634 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -71195,7 +71887,7 @@ paths: application/json: schema: type: array - items: &450 + items: &453 title: Porter Author description: Porter Author type: object @@ -71249,7 +71941,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': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71274,8 +71966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *280 - - *281 + - *283 + - *284 - name: author_id in: path required: true @@ -71305,7 +71997,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -71318,7 +72010,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71342,8 +72034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71384,7 +72076,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71412,8 +72104,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -71440,11 +72132,11 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: - default: *451 + default: *454 '422': *15 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71467,8 +72159,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71476,8 +72168,8 @@ paths: application/json: schema: *20 examples: - default: *452 - '301': *294 + default: *455 + '301': *297 '404': *6 x-github: githubCloudOnly: false @@ -71497,8 +72189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71506,12 +72198,12 @@ paths: application/json: schema: anyOf: - - *193 + - *196 - type: object properties: {} additionalProperties: false examples: - default: &454 + default: &457 value: limit: collaborators_only origin: repository @@ -71536,13 +72228,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: application/json: - schema: *453 + schema: *456 examples: default: summary: Example request body @@ -71554,9 +72246,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *454 + default: *457 '409': description: Response x-github: @@ -71578,8 +72270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -71602,8 +72294,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -71613,9 +72305,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: &624 + default: &627 value: - id: 1 repository: @@ -71746,9 +72438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *280 - - *281 - - *197 + - *283 + - *284 + - *200 requestBody: required: false content: @@ -71777,7 +72469,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: default: value: @@ -71908,9 +72600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *280 - - *281 - - *197 + - *283 + - *284 + - *200 responses: '204': description: Response @@ -71941,8 +72633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *280 - - *281 + - *283 + - *284 - 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 @@ -71982,7 +72674,7 @@ paths: required: false schema: type: string - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -71995,7 +72687,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -72005,7 +72697,7 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: default: value: @@ -72155,7 +72847,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *294 + '301': *297 '422': *15 '404': *6 x-github: @@ -72184,8 +72876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -72266,9 +72958,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: &459 + default: &462 value: id: 1 node_id: MDU6SXNzdWUx @@ -72424,7 +73116,7 @@ paths: '422': *15 '503': *81 '404': *6 - '410': *291 + '410': *294 x-github: triggersNotification: true githubCloudOnly: false @@ -72452,9 +73144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *280 - - *281 - - *107 + - *283 + - *284 + - *110 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72464,7 +73156,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -72474,9 +73166,9 @@ paths: application/json: schema: type: array - items: *456 + items: *459 examples: - default: &461 + default: &464 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -72534,17 +73226,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: &457 + default: &460 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -72598,9 +73290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -72622,9 +73314,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '422': *15 x-github: githubCloudOnly: false @@ -72642,9 +73334,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -72664,9 +73356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -72692,9 +73384,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -72715,9 +73407,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -72749,16 +73441,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -72780,10 +73472,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -72803,8 +73495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -72814,7 +73506,7 @@ paths: application/json: schema: type: array - items: &458 + items: &461 title: Issue Event description: Issue Event type: object @@ -72861,7 +73553,7 @@ paths: issue: anyOf: - type: 'null' - - *98 + - *101 label: title: Issue Event Label description: Issue Event Label @@ -72894,7 +73586,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *198 + requested_team: *201 dismissed_review: title: Issue Event Dismissed Review type: object @@ -72961,7 +73653,7 @@ paths: required: - from - to - author_association: *85 + author_association: *88 lock_reason: type: - string @@ -73153,8 +73845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *280 - - *281 + - *283 + - *284 - name: event_id in: path required: true @@ -73165,7 +73857,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: default: value: @@ -73358,7 +74050,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *291 + '410': *294 '403': *27 x-github: githubCloudOnly: false @@ -73392,9 +74084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *280 - - *281 - - &460 + - *283 + - *284 + - &463 name: issue_number description: The number that identifies the issue. in: path @@ -73406,12 +74098,12 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 - '301': *294 + default: *462 + '301': *297 '404': *6 - '410': *291 + '410': *294 '304': *35 x-github: githubCloudOnly: false @@ -73436,9 +74128,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -73546,15 +74238,15 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 '422': *15 '503': *81 '403': *27 - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73572,9 +74264,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -73600,9 +74292,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73618,9 +74310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: content: application/json: @@ -73645,9 +74337,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73669,9 +74361,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: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - name: assignee in: path required: true @@ -73711,10 +74403,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *280 - - *281 - - *460 - - *88 + - *283 + - *284 + - *463 + - *91 - *17 - *18 responses: @@ -73724,13 +74416,13 @@ paths: application/json: schema: type: array - items: *456 + items: *459 examples: - default: *461 + default: *464 headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73759,9 +74451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: true content: @@ -73783,16 +74475,16 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *291 + '410': *294 '422': *15 '404': *6 x-github: @@ -73812,9 +74504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -73828,7 +74520,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &464 + - &467 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -73877,7 +74569,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &465 + - &468 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -74005,7 +74697,7 @@ paths: - performed_via_github_app - assignee - assigner - - &466 + - &469 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -74051,7 +74743,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &467 + - &470 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -74097,7 +74789,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &468 + - &471 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -74146,7 +74838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &469 + - &472 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -74175,7 +74867,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *198 + requested_team: *201 requested_reviewer: *4 required: - review_requester @@ -74188,7 +74880,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &470 + - &473 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -74217,7 +74909,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *198 + requested_team: *201 requested_reviewer: *4 required: - review_requester @@ -74230,7 +74922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &471 + - &474 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -74286,7 +74978,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &472 + - &475 title: Locked Issue Event description: Locked Issue Event type: object @@ -74331,7 +75023,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &473 + - &476 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -74392,7 +75084,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &474 + - &477 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -74453,7 +75145,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &475 + - &478 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -74514,7 +75206,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &476 + - &479 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -74607,7 +75299,7 @@ paths: color: red headers: Link: *37 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74624,9 +75316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -74636,7 +75328,7 @@ paths: application/json: schema: type: array - items: &462 + items: &465 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -74691,7 +75383,7 @@ paths: - color - default examples: - default: &463 + default: &466 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74709,9 +75401,9 @@ paths: default: false headers: Link: *37 - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74728,9 +75420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -74789,12 +75481,12 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 - '301': *294 + default: *466 + '301': *297 '404': *6 - '410': *291 + '410': *294 '422': *15 x-github: githubCloudOnly: false @@ -74811,9 +75503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -74873,12 +75565,12 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 - '301': *294 + default: *466 + '301': *297 '404': *6 - '410': *291 + '410': *294 '422': *15 x-github: githubCloudOnly: false @@ -74895,15 +75587,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 responses: '204': description: Response - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74922,9 +75614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - name: name in: path required: true @@ -74937,7 +75629,7 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: default: value: @@ -74948,9 +75640,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74970,9 +75662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -75001,7 +75693,7 @@ paths: '204': description: Response '403': *27 - '410': *291 + '410': *294 '404': *6 '422': *15 x-github: @@ -75019,9 +75711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 responses: '204': description: Response @@ -75043,9 +75735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - 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. @@ -75071,13 +75763,13 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75095,9 +75787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: true content: @@ -75129,16 +75821,16 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -75160,10 +75852,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *280 - - *281 - - *460 - - *272 + - *283 + - *284 + - *463 + - *275 responses: '204': description: Response @@ -75183,9 +75875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -75200,9 +75892,6 @@ paths: description: Timeline Event type: object anyOf: - - *464 - - *465 - - *466 - *467 - *468 - *469 @@ -75213,6 +75902,9 @@ paths: - *474 - *475 - *476 + - *477 + - *478 + - *479 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -75260,12 +75952,12 @@ paths: issue_url: type: string format: uri - author_association: *85 + author_association: *88 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - event - actor @@ -75296,7 +75988,7 @@ paths: properties: type: type: string - issue: *98 + issue: *101 required: - event - created_at @@ -75508,7 +76200,7 @@ paths: type: string body_text: type: string - author_association: *85 + author_association: *88 required: - event - id @@ -75531,7 +76223,7 @@ paths: type: string comments: type: array - items: &496 + items: &499 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -75636,7 +76328,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *85 + author_association: *88 _links: type: object properties: @@ -75731,7 +76423,7 @@ paths: enum: - line - file - reactions: *86 + reactions: *89 body_html: type: string examples: @@ -75769,7 +76461,7 @@ paths: type: string comments: type: array - items: *392 + items: *395 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -76044,7 +76736,7 @@ paths: headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76061,8 +76753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -76072,7 +76764,7 @@ paths: application/json: schema: type: array - items: &477 + items: &480 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -76136,8 +76828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76173,9 +76865,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: &478 + default: &481 value: id: 1 key: ssh-rsa AAA... @@ -76208,9 +76900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *280 - - *281 - - &479 + - *283 + - *284 + - &482 name: key_id description: The unique identifier of the key. in: path @@ -76222,9 +76914,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: *478 + default: *481 '404': *6 x-github: githubCloudOnly: false @@ -76242,9 +76934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *280 - - *281 - - *479 + - *283 + - *284 + - *482 responses: '204': description: Response @@ -76264,8 +76956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -76275,9 +76967,9 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 + default: *466 headers: Link: *37 '404': *6 @@ -76298,8 +76990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76335,9 +77027,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &480 + default: &483 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -76369,8 +77061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76381,9 +77073,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *480 + default: *483 '404': *6 x-github: githubCloudOnly: false @@ -76400,8 +77092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76440,7 +77132,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -76466,8 +77158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76493,8 +77185,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -76530,10 +77222,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '202': *120 + '202': *123 '403': description: |- We will return a 403 with one of the following messages: @@ -76559,8 +77251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -76586,9 +77278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *280 - - *281 - - *369 + - *283 + - *284 + - *372 responses: '200': description: Response @@ -76654,7 +77346,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 required: - _links - git_url @@ -76735,8 +77427,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76801,8 +77493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76836,9 +77528,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *393 + schema: *396 examples: - default: *481 + default: *484 '204': description: Response when already merged '404': @@ -76863,8 +77555,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -76905,7 +77597,7 @@ paths: application/json: schema: type: array - items: *397 + items: *400 examples: default: value: @@ -76961,8 +77653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77002,9 +77694,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: &482 + default: &485 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -77063,9 +77755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *280 - - *281 - - &483 + - *283 + - *284 + - &486 name: milestone_number description: The number that identifies the milestone. in: path @@ -77077,9 +77769,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *482 + default: *485 '404': *6 x-github: githubCloudOnly: false @@ -77096,9 +77788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 requestBody: required: false content: @@ -77136,9 +77828,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *482 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77154,9 +77846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 responses: '204': description: Response @@ -77177,9 +77869,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: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 - *17 - *18 responses: @@ -77189,9 +77881,9 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 + default: *466 headers: Link: *37 x-github: @@ -77210,12 +77902,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: - - *280 - - *281 - - *484 - - *485 - - *88 - - *486 + - *283 + - *284 + - *487 + - *488 + - *91 + - *489 - *17 - *18 responses: @@ -77225,9 +77917,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *487 + default: *490 headers: Link: *37 x-github: @@ -77251,8 +77943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -77310,14 +78002,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &488 + schema: &491 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -77461,7 +78153,7 @@ paths: - custom_404 - public examples: - default: &489 + default: &492 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -77502,8 +78194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77558,11 +78250,11 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: *489 + default: *492 '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77583,8 +78275,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77671,7 +78363,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77692,14 +78384,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77719,8 +78411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -77730,7 +78422,7 @@ paths: application/json: schema: type: array - items: &490 + items: &493 title: Page Build description: Page Build type: object @@ -77822,8 +78514,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -77870,16 +78562,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: &491 + default: &494 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -77927,8 +78619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *280 - - *281 + - *283 + - *284 - name: build_id in: path required: true @@ -77939,9 +78631,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *491 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77961,8 +78653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78071,9 +78763,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: - - *280 - - *281 - - &492 + - *283 + - *284 + - &495 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -78131,11 +78823,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *280 - - *281 - - *492 + - *283 + - *284 + - *495 responses: - '204': *163 + '204': *166 '404': *6 x-github: githubCloudOnly: false @@ -78160,8 +78852,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -78429,7 +79121,7 @@ paths: description: Empty response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -78456,8 +79148,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Private vulnerability reporting status @@ -78494,10 +79186,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '204': *163 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -78516,10 +79208,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '204': *163 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -78540,8 +79232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: Indicates the state of the projects to return. in: query @@ -78562,7 +79254,7 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: default: value: @@ -78602,7 +79294,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -78622,8 +79314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78649,13 +79341,13 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *290 + default: *293 '401': *23 '403': *27 '404': *6 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -78675,8 +79367,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -78684,7 +79376,7 @@ paths: application/json: schema: type: array - items: *231 + items: *234 examples: default: value: @@ -78715,8 +79407,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78728,7 +79420,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *231 + items: *234 required: - properties examples: @@ -78778,8 +79470,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -78839,9 +79531,9 @@ paths: application/json: schema: type: array - items: *493 + items: *496 examples: - default: *494 + default: *497 headers: Link: *37 '304': *35 @@ -78873,8 +79565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78941,7 +79633,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &501 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -79070,7 +79762,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 active_lock_reason: type: - string @@ -79125,7 +79817,7 @@ paths: type: - array - 'null' - items: *211 + items: *214 head: type: object properties: @@ -79163,14 +79855,14 @@ paths: _links: type: object properties: - comments: *398 - commits: *398 - statuses: *398 - html: *398 - issue: *398 - review_comments: *398 - review_comment: *398 - self: *398 + comments: *401 + commits: *401 + statuses: *401 + html: *401 + issue: *401 + review_comments: *401 + review_comment: *401 + self: *401 required: - comments - commits @@ -79180,8 +79872,8 @@ paths: - review_comments - review_comment - self - author_association: *85 - auto_merge: *495 + author_association: *88 + auto_merge: *498 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -79283,7 +79975,7 @@ paths: - merged_by - review_comments examples: - default: &499 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79810,8 +80502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - name: sort in: query required: false @@ -79830,7 +80522,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -79840,9 +80532,9 @@ paths: application/json: schema: type: array - items: *496 + items: *499 examples: - default: &501 + default: &504 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79919,17 +80611,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *496 + schema: *499 examples: - default: &497 + default: &500 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80004,9 +80696,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -80028,9 +80720,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: - default: *497 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80046,9 +80738,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -80069,9 +80761,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -80097,9 +80789,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -80120,9 +80812,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -80154,16 +80846,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -80185,10 +80877,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -80231,9 +80923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *280 - - *281 - - &500 + - *283 + - *284 + - &503 name: pull_number description: The number that identifies the pull request. in: path @@ -80246,9 +80938,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *498 + schema: *501 examples: - default: *499 + default: *502 '304': *35 '404': *6 '406': @@ -80283,9 +80975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -80327,9 +81019,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *501 examples: - default: *499 + default: *502 '422': *15 '403': *27 x-github: @@ -80351,9 +81043,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -80414,17 +81106,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -80454,10 +81146,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: - - *280 - - *281 - - *500 - - *107 + - *283 + - *284 + - *503 + - *110 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -80467,7 +81159,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -80477,9 +81169,9 @@ paths: application/json: schema: type: array - items: *496 + items: *499 examples: - default: *501 + default: *504 headers: Link: *37 x-github: @@ -80512,9 +81204,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -80620,7 +81312,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: example-for-a-multi-line-comment: value: @@ -80708,10 +81400,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: - - *280 - - *281 - - *500 - - *97 + - *283 + - *284 + - *503 + - *100 requestBody: required: true content: @@ -80733,7 +81425,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: default: value: @@ -80819,9 +81511,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -80831,9 +81523,9 @@ paths: application/json: schema: type: array - items: *393 + items: *396 examples: - default: *502 + default: *505 headers: Link: *37 x-github: @@ -80863,9 +81555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -80875,7 +81567,7 @@ paths: application/json: schema: type: array - items: *405 + items: *408 examples: default: value: @@ -80913,9 +81605,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 responses: '204': description: Response if pull request has been merged @@ -80938,9 +81630,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -81052,9 +81744,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 responses: '200': description: Response @@ -81070,7 +81762,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 required: - users - teams @@ -81129,9 +81821,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -81168,7 +81860,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *496 examples: default: value: @@ -81704,9 +82396,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -81740,7 +82432,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *496 examples: default: value: @@ -82245,9 +82937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -82257,7 +82949,7 @@ paths: application/json: schema: type: array - items: &503 + items: &506 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -82331,7 +83023,7 @@ paths: type: string body_text: type: string - author_association: *85 + author_association: *88 required: - id - node_id @@ -82413,9 +83105,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -82505,9 +83197,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: &505 + default: &508 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82570,10 +83262,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: - - *280 - - *281 - - *500 - - &504 + - *283 + - *284 + - *503 + - &507 name: review_id description: The unique identifier of the review. in: path @@ -82585,9 +83277,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: &506 + default: &509 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82646,10 +83338,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -82672,7 +83364,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: default: value: @@ -82734,18 +83426,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 responses: '200': description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: *505 + default: *508 '422': *7 '404': *6 x-github: @@ -82772,10 +83464,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 - *17 - *18 responses: @@ -82869,13 +83561,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *85 + author_association: *88 _links: type: object properties: - self: *398 - html: *398 - pull_request: *398 + self: *401 + html: *401 + pull_request: *401 required: - self - html @@ -82884,7 +83576,7 @@ paths: type: string body_html: type: string - reactions: *86 + reactions: *89 side: description: The side of the first line of the range for a multi-line comment. @@ -83026,10 +83718,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -83058,7 +83750,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: default: value: @@ -83121,10 +83813,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -83159,9 +83851,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: *506 + default: *509 '404': *6 '422': *7 '403': *27 @@ -83183,9 +83875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -83249,8 +83941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *280 - - *281 + - *283 + - *284 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -83263,9 +83955,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: - default: &508 + default: &511 value: type: file encoding: base64 @@ -83307,8 +83999,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: - - *280 - - *281 + - *283 + - *284 - name: dir description: The alternate path to look for a README file in: path @@ -83328,9 +84020,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: - default: *508 + default: *511 '404': *6 '422': *15 x-github: @@ -83352,8 +84044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -83363,7 +84055,7 @@ paths: application/json: schema: type: array - items: &509 + items: &512 title: Release description: A release. type: object @@ -83435,7 +84127,7 @@ paths: author: *4 assets: type: array - items: &510 + items: &513 title: Release Asset description: Data related to a release. type: object @@ -83505,7 +84197,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *86 + reactions: *89 required: - assets_url - upload_url @@ -83615,8 +84307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -83692,9 +84384,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: &513 + default: &516 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -83795,9 +84487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *280 - - *281 - - &511 + - *283 + - *284 + - &514 name: asset_id description: The unique identifier of the asset. in: path @@ -83809,9 +84501,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: &512 + default: &515 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 @@ -83845,7 +84537,7 @@ paths: type: User site_admin: false '404': *6 - '302': *407 + '302': *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83861,9 +84553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *280 - - *281 - - *511 + - *283 + - *284 + - *514 requestBody: required: false content: @@ -83892,9 +84584,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *512 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83910,9 +84602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *280 - - *281 - - *511 + - *283 + - *284 + - *514 responses: '204': description: Response @@ -83936,8 +84628,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -84023,16 +84715,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84049,8 +84741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *280 - - *281 + - *283 + - *284 - name: tag description: tag parameter in: path @@ -84063,9 +84755,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 '404': *6 x-github: githubCloudOnly: false @@ -84087,9 +84779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *280 - - *281 - - &514 + - *283 + - *284 + - &517 name: release_id description: The unique identifier of the release. in: path @@ -84103,9 +84795,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: *509 + schema: *512 examples: - default: *513 + default: *516 '401': description: Unauthorized x-github: @@ -84123,9 +84815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 requestBody: required: false content: @@ -84189,9 +84881,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 '404': description: Not Found if the discussion category name is invalid content: @@ -84212,9 +84904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 responses: '204': description: Response @@ -84234,9 +84926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - *17 - *18 responses: @@ -84246,7 +84938,7 @@ paths: application/json: schema: type: array - items: *510 + items: *513 examples: default: value: @@ -84327,9 +85019,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: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - name: name in: query required: true @@ -84355,7 +85047,7 @@ paths: description: Response for successful upload content: application/json: - schema: *510 + schema: *513 examples: response-for-successful-upload: value: @@ -84409,9 +85101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - 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. @@ -84435,9 +85127,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -84458,9 +85150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 requestBody: required: true content: @@ -84490,16 +85182,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -84521,10 +85213,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *280 - - *281 - - *514 - - *272 + - *283 + - *284 + - *517 + - *275 responses: '204': description: Response @@ -84548,9 +85240,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 - *17 - *18 responses: @@ -84566,8 +85258,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *515 - - &517 + - *518 + - &520 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84586,54 +85278,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *516 - - *517 - - allOf: - - *518 - - *517 - allOf: - *519 - - *517 - - allOf: - *520 - - *517 - allOf: - *521 - - *517 + - *520 - allOf: - *522 - - *517 + - *520 - allOf: - *523 - - *517 + - *520 - allOf: - *524 - - *517 + - *520 - allOf: - *525 - - *517 + - *520 - allOf: - *526 - - *517 + - *520 - allOf: - *527 - - *517 + - *520 - allOf: - *528 - - *517 + - *520 - allOf: - *529 - - *517 + - *520 - allOf: - *530 - - *517 + - *520 - allOf: - *531 - - *517 + - *520 - allOf: - *532 - - *517 + - *520 + - allOf: + - *533 + - *520 + - allOf: + - *534 + - *520 + - allOf: + - *535 + - *520 examples: default: value: @@ -84672,8 +85364,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - name: includes_parents @@ -84684,7 +85376,7 @@ paths: schema: type: boolean default: true - - *533 + - *536 responses: '200': description: Response @@ -84692,7 +85384,7 @@ paths: application/json: schema: type: array - items: *241 + items: *244 examples: default: value: @@ -84739,8 +85431,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 requestBody: description: Request body required: true @@ -84760,16 +85452,16 @@ paths: - tag - push default: branch - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *235 + items: *241 + conditions: *238 rules: type: array description: An array of rules within the ruleset. - items: *240 + items: *243 required: - name - enforcement @@ -84800,9 +85492,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: &543 + default: &546 value: id: 42 name: super cool ruleset @@ -84849,12 +85541,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *280 - - *281 - - *534 - - *535 - - *536 + - *283 + - *284 - *537 + - *538 + - *539 + - *540 - *17 - *18 responses: @@ -84862,9 +85554,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *541 examples: - default: *539 + default: *542 '404': *6 '500': *69 x-github: @@ -84885,17 +85577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *280 - - *281 - - *540 + - *283 + - *284 + - *543 responses: '200': description: Response content: application/json: - schema: *541 + schema: *544 examples: - default: *542 + default: *545 '404': *6 '500': *69 x-github: @@ -84923,8 +85615,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84944,9 +85636,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *543 + default: *546 '404': *6 '500': *69 put: @@ -84964,8 +85656,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84990,16 +85682,16 @@ paths: - branch - tag - push - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *235 + items: *241 + conditions: *238 rules: description: An array of rules within the ruleset. type: array - items: *240 + items: *243 examples: default: value: @@ -85027,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *543 + default: *546 '404': *6 '500': *69 delete: @@ -85047,8 +85739,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85076,20 +85768,20 @@ 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: - - *280 - - *281 - - *243 - - *244 - - *245 + - *283 + - *284 - *246 - - *65 - - *18 - - *17 - - *544 - - *545 - *247 - *248 - *249 + - *65 + - *18 + - *17 + - *547 + - *548 + - *250 + - *251 + - *252 responses: '200': description: Response @@ -85097,7 +85789,7 @@ paths: application/json: schema: type: array - items: &548 + items: &551 type: object properties: number: *70 @@ -85113,8 +85805,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *546 - resolution: *547 + state: *549 + resolution: *550 resolved_at: type: - string @@ -85279,15 +85971,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 responses: '200': description: Response content: application/json: - schema: *548 + schema: *551 examples: default: value: @@ -85335,9 +86027,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 requestBody: required: true content: @@ -85345,8 +86037,8 @@ paths: schema: type: object properties: - state: *546 - resolution: *547 + state: *549 + resolution: *550 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -85365,7 +86057,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *551 examples: default: value: @@ -85436,9 +86128,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 - *18 - *17 responses: @@ -85449,7 +86141,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &703 + items: &706 type: object properties: type: @@ -85828,8 +86520,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -85837,14 +86529,14 @@ paths: schema: type: object properties: - reason: &550 + reason: &553 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *549 + placeholder_id: *552 required: - reason - placeholder_id @@ -85861,7 +86553,7 @@ paths: schema: type: object properties: - reason: *550 + reason: *553 expire_at: type: - string @@ -85907,8 +86599,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *280 - - *281 + - *283 + - *284 - *65 - name: sort description: The property to sort the results by. @@ -85952,9 +86644,9 @@ paths: application/json: schema: type: array - items: *551 + items: *554 examples: - default: *552 + default: *555 '400': *14 '404': *6 x-github: @@ -85977,8 +86669,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -86058,7 +86750,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 required: - login - type @@ -86148,9 +86840,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: &554 + default: &557 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -86383,8 +87075,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -86497,7 +87189,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: default: value: @@ -86644,17 +87336,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: '200': description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: *554 + default: *557 '403': *27 '404': *6 x-github: @@ -86678,9 +87370,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 requestBody: required: true content: @@ -86760,7 +87452,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 required: - login - type @@ -86851,17 +87543,17 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: *554 - add_credit: *554 + default: *557 + add_credit: *557 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *117 + schema: *120 examples: invalid_state_transition: value: @@ -86892,11 +87584,11 @@ 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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: - '202': *120 + '202': *123 '400': *14 '403': *27 '404': *6 @@ -86921,17 +87613,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: '202': description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 '400': *14 '422': *15 '403': *27 @@ -86957,8 +87649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87054,8 +87746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -87064,7 +87756,7 @@ paths: application/json: schema: type: array - items: &555 + items: &558 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -87076,8 +87768,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *120 - '204': *163 + '202': *123 + '204': *166 '422': description: Repository contains more than 10,000 commits x-github: @@ -87097,8 +87789,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87148,8 +87840,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *120 - '204': *163 + '202': *123 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87176,8 +87868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87248,8 +87940,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *120 - '204': *163 + '202': *123 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87271,8 +87963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -87426,8 +88118,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -87437,7 +88129,7 @@ paths: application/json: schema: type: array - items: *555 + items: *558 examples: default: value: @@ -87450,7 +88142,7 @@ paths: - - 0 - 2 - 21 - '204': *163 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87470,8 +88162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *280 - - *281 + - *283 + - *284 - name: sha in: path required: true @@ -87527,7 +88219,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *559 examples: default: value: @@ -87581,8 +88273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87594,7 +88286,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -87614,14 +88306,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &557 + schema: &560 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -87694,8 +88386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -87721,7 +88413,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *560 examples: default: value: @@ -87748,8 +88440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -87769,8 +88461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87852,8 +88544,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87861,7 +88553,7 @@ paths: application/json: schema: type: array - items: &558 + items: &561 title: Tag protection description: Tag protection type: object @@ -87918,8 +88610,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -87942,7 +88634,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *561 examples: default: value: @@ -87973,8 +88665,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: - - *280 - - *281 + - *283 + - *284 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -88011,8 +88703,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *280 - - *281 + - *283 + - *284 - name: ref in: path required: true @@ -88048,8 +88740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -88059,9 +88751,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 headers: Link: *37 '404': *6 @@ -88081,8 +88773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 responses: @@ -88090,7 +88782,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &562 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -88102,7 +88794,7 @@ paths: required: - names examples: - default: &560 + default: &563 value: names: - octocat @@ -88125,8 +88817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -88157,9 +88849,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *562 examples: - default: *560 + default: *563 '404': *6 '422': *7 x-github: @@ -88180,9 +88872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *280 - - *281 - - &561 + - *283 + - *284 + - &564 name: per description: The time frame to display results for. in: query @@ -88213,7 +88905,7 @@ paths: - 128 clones: type: array - items: &562 + items: &565 title: Traffic type: object properties: @@ -88300,8 +88992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -88395,8 +89087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -88459,9 +89151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *280 - - *281 - - *561 + - *283 + - *284 + - *564 responses: '200': description: Response @@ -88482,7 +89174,7 @@ paths: - 3782 views: type: array - items: *562 + items: *565 required: - uniques - count @@ -88559,8 +89251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -88596,7 +89288,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *135 examples: default: value: @@ -88834,8 +89526,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -88858,8 +89550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -88881,8 +89573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -88908,8 +89600,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *280 - - *281 + - *283 + - *284 - name: ref in: path required: true @@ -89001,9 +89693,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -89044,7 +89736,7 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: default: value: @@ -89157,7 +89849,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &570 + - &573 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -89167,7 +89859,7 @@ paths: type: string examples: - members - - &575 + - &578 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -89179,7 +89871,7 @@ paths: format: int32 examples: - 1 - - &576 + - &579 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -89223,7 +89915,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &564 + items: &567 allOf: - type: object required: @@ -89305,7 +89997,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: &577 + meta: &580 type: object description: The metadata associated with the creation/updates to the user. @@ -89370,31 +90062,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e startIndex: 1 itemsPerPage: 20 - '400': &565 + '400': &568 description: Bad request content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '401': &566 + schema: *566 + '401': &569 description: Authorization failure - '403': &567 + '403': &570 description: Permission denied - '429': &568 + '429': &571 description: Too many requests content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '500': &569 + schema: *566 + '500': &572 description: Internal server error content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 + schema: *566 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89421,7 +90113,7 @@ paths: required: true content: application/json: - schema: &573 + schema: &576 type: object required: - schemas @@ -89481,9 +90173,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *564 + schema: *567 examples: - group: &571 + group: &574 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -89502,13 +90194,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e - '400': *565 - '401': *566 - '403': *567 - '409': &574 + '400': *568 + '401': *569 + '403': *570 + '409': &577 description: Duplicate record detected - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89529,7 +90221,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: - - &572 + - &575 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -89538,22 +90230,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *570 + - *573 - *38 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *564 + schema: *567 examples: - default: *571 - '400': *565 - '401': *566 - '403': *567 + default: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89575,13 +90267,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: - - *572 + - *575 - *38 requestBody: required: true content: application/json: - schema: *573 + schema: *576 examples: group: summary: Group @@ -89607,17 +90299,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *564 + schema: *567 examples: - group: *571 - groupWithMembers: *571 - '400': *565 - '401': *566 - '403': *567 + group: *574 + groupWithMembers: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89644,13 +90336,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: - - *572 + - *575 - *38 requestBody: required: true content: application/json: - schema: &584 + schema: &587 type: object required: - Operations @@ -89710,17 +90402,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *564 + schema: *567 examples: - updateGroup: *571 - addMembers: *571 - '400': *565 - '401': *566 - '403': *567 + updateGroup: *574 + addMembers: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89740,17 +90432,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: - - *572 + - *575 - *38 responses: '204': description: Group was deleted, no content - '400': *565 - '401': *566 - '403': *567 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89787,8 +90479,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *575 - - *576 + - *578 + - *579 - *38 responses: '200': @@ -89822,7 +90514,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &579 + items: &582 allOf: - type: object required: @@ -89914,7 +90606,7 @@ paths: address. examples: - true - roles: &578 + roles: &581 type: array description: The roles assigned to the user. items: @@ -89973,7 +90665,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *577 + meta: *580 startIndex: type: integer description: A starting index for the returned page @@ -90012,11 +90704,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *565 - '401': *566 - '403': *567 - '429': *568 - '500': *569 + '400': *568 + '401': *569 + '403': *570 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90043,7 +90735,7 @@ paths: required: true content: application/json: - schema: &582 + schema: &585 type: object required: - schemas @@ -90136,9 +90828,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *578 + roles: *581 examples: - user: &583 + user: &586 summary: User value: schemas: @@ -90185,9 +90877,9 @@ paths: description: User has been created content: application/scim+json: - schema: *579 + schema: *582 examples: - user: &580 + user: &583 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90213,13 +90905,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: *580 - '400': *565 - '401': *566 - '403': *567 - '409': *574 - '429': *568 - '500': *569 + enterpriseOwner: *583 + '400': *568 + '401': *569 + '403': *570 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90240,7 +90932,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: - - &581 + - &584 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -90253,15 +90945,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *579 + schema: *582 examples: - default: *580 - '400': *565 - '401': *566 - '403': *567 + default: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90286,30 +90978,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: - - *581 + - *584 - *38 requestBody: required: true content: application/json: - schema: *582 + schema: *585 examples: - user: *583 + user: *586 responses: '200': description: User was updated content: application/scim+json: - schema: *579 + schema: *582 examples: - user: *580 - '400': *565 - '401': *566 - '403': *567 + user: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90347,13 +91039,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: - - *581 + - *584 - *38 requestBody: required: true content: application/json: - schema: *584 + schema: *587 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -90393,18 +91085,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *579 - examples: - userMultiValuedProperties: *580 - userSingleValuedProperties: *580 - disableUser: *580 - '400': *565 - '401': *566 - '403': *567 + schema: *582 + examples: + userMultiValuedProperties: *583 + userSingleValuedProperties: *583 + disableUser: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90424,17 +91116,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: - - *581 + - *584 - *38 responses: '204': description: User was deleted, no content - '400': *565 - '401': *566 - '403': *567 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90467,7 +91159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *114 + - *117 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -90525,7 +91217,7 @@ paths: - 1 Resources: type: array - items: &585 + items: &588 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -90772,22 +91464,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &586 + '404': &589 description: Resource not found content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '403': &587 + schema: *566 + '403': &590 description: Forbidden content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '400': *565 - '429': *568 + schema: *566 + '400': *568 + '429': *571 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -90807,15 +91499,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *114 + - *117 responses: '201': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: &588 + default: &591 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90838,17 +91530,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *586 - '403': *587 - '500': *569 + '404': *589 + '403': *590 + '500': *572 '409': description: Conflict content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '400': *565 + schema: *566 + '400': *568 requestBody: required: true content: @@ -90942,18 +91634,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 - '404': *586 - '403': *587 + default: *591 + '404': *589 + '403': *590 '304': *35 x-github: githubCloudOnly: true @@ -90976,19 +91668,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 + default: *591 '304': *35 - '404': *586 - '403': *587 + '404': *589 + '403': *590 requestBody: required: true content: @@ -91098,20 +91790,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 + default: *591 '304': *35 - '404': *586 - '403': *587 - '400': *565 + '404': *589 + '403': *590 + '400': *568 '429': description: Response content: @@ -91206,13 +91898,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *114 - - *581 + - *117 + - *584 responses: '204': description: Response - '404': *586 - '403': *587 + '404': *589 + '403': *590 '304': *35 x-github: githubCloudOnly: true @@ -91327,7 +92019,7 @@ paths: html_url: type: string format: uri - repository: *132 + repository: *135 score: type: number file_size: @@ -91346,7 +92038,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &589 + text_matches: &592 title: Search Result Text Matches type: array items: @@ -91510,7 +92202,7 @@ paths: enum: - author-date - committer-date - - &590 + - &593 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 @@ -91579,7 +92271,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 comment_count: type: integer message: @@ -91598,7 +92290,7 @@ paths: url: type: string format: uri - verification: *442 + verification: *445 required: - author - committer @@ -91613,7 +92305,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 parents: type: array items: @@ -91625,12 +92317,12 @@ paths: type: string sha: type: string - repository: *132 + repository: *135 score: type: number node_id: type: string - text_matches: *589 + text_matches: *592 required: - sha - node_id @@ -91823,7 +92515,7 @@ paths: - interactions - created - updated - - *590 + - *593 - *17 - *18 responses: @@ -91925,7 +92617,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 comments: type: integer created_at: @@ -91939,7 +92631,7 @@ paths: - string - 'null' format: date-time - text_matches: *589 + text_matches: *592 pull_request: type: object properties: @@ -91977,7 +92669,7 @@ paths: type: string score: type: number - author_association: *85 + author_association: *88 draft: type: boolean repository: *55 @@ -91992,7 +92684,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - assignee - closed_at @@ -92161,7 +92853,7 @@ paths: enum: - created - updated - - *590 + - *593 - *17 - *18 responses: @@ -92206,7 +92898,7 @@ paths: - 'null' score: type: number - text_matches: *589 + text_matches: *592 required: - id - node_id @@ -92292,7 +92984,7 @@ paths: - forks - help-wanted-issues - updated - - *590 + - *593 - *17 - *18 responses: @@ -92511,7 +93203,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 permissions: type: object properties: @@ -92529,7 +93221,7 @@ paths: - admin - pull - push - text_matches: *589 + text_matches: *592 temp_clone_token: type: string allow_merge_commit: @@ -92838,7 +93530,7 @@ paths: - string - 'null' format: uri - text_matches: *589 + text_matches: *592 related: type: - array @@ -93033,7 +93725,7 @@ paths: - followers - repositories - joined - - *590 + - *593 - *17 - *18 responses: @@ -93143,7 +93835,7 @@ paths: type: - boolean - 'null' - text_matches: *589 + text_matches: *592 blog: type: - string @@ -93225,7 +93917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &591 + - &594 name: team_id description: The unique identifier of the team. in: path @@ -93237,9 +93929,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 x-github: githubCloudOnly: false @@ -93266,7 +93958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *591 + - *594 requestBody: required: true content: @@ -93330,16 +94022,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '201': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 '422': *15 '403': *27 @@ -93367,7 +94059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *591 + - *594 responses: '204': description: Response @@ -93398,7 +94090,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *591 + - *594 - *65 - *17 - *18 @@ -93409,9 +94101,9 @@ paths: application/json: schema: type: array - items: *263 + items: *266 examples: - default: *592 + default: *595 headers: Link: *37 x-github: @@ -93440,7 +94132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *591 + - *594 requestBody: required: true content: @@ -93474,9 +94166,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: triggersNotification: true githubCloudOnly: false @@ -93503,16 +94195,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 responses: '200': description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93537,8 +94229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 requestBody: required: false content: @@ -93561,9 +94253,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *593 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93588,8 +94280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 responses: '204': description: Response @@ -93618,8 +94310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *591 - - *265 + - *594 + - *268 - *65 - *17 - *18 @@ -93630,9 +94322,9 @@ paths: application/json: schema: type: array - items: *266 + items: *269 examples: - default: *594 + default: *597 headers: Link: *37 x-github: @@ -93661,8 +94353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 + - *268 requestBody: required: true content: @@ -93684,9 +94376,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: triggersNotification: true githubCloudOnly: false @@ -93713,17 +94405,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 responses: '200': description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93748,9 +94440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 requestBody: required: true content: @@ -93772,9 +94464,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *595 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93799,9 +94491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 responses: '204': description: Response @@ -93830,9 +94522,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: - - *591 - - *265 + - *594 - *268 + - *271 - 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. @@ -93858,9 +94550,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -93889,9 +94581,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: - - *591 - - *265 + - *594 - *268 + - *271 requestBody: required: true content: @@ -93923,9 +94615,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93951,8 +94643,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: - - *591 - - *265 + - *594 + - *268 - 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. @@ -93978,9 +94670,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -94009,8 +94701,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: - - *591 - - *265 + - *594 + - *268 requestBody: required: true content: @@ -94042,9 +94734,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94068,7 +94760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94078,9 +94770,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 x-github: @@ -94106,7 +94798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *591 + - *594 - name: role description: Filters members returned by their role in the team. in: query @@ -94129,7 +94821,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -94157,8 +94849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: if user is a member @@ -94194,8 +94886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94234,8 +94926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94271,16 +94963,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: - - *591 - - *154 + - *594 + - *157 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-user-is-a-team-maintainer: *596 + response-if-user-is-a-team-maintainer: *599 '404': *6 x-github: githubCloudOnly: false @@ -94313,8 +95005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *591 - - *154 + - *594 + - *157 requestBody: required: false content: @@ -94339,9 +95031,9 @@ paths: description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-users-membership-with-team-is-now-pending: *597 + response-if-users-membership-with-team-is-now-pending: *600 '403': description: Forbidden if team synchronization is set up '422': @@ -94375,8 +95067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94405,7 +95097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94415,9 +95107,9 @@ paths: application/json: schema: type: array - items: *278 + items: *281 examples: - default: *598 + default: *601 headers: Link: *37 '404': *6 @@ -94444,16 +95136,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: - - *591 - - *279 + - *594 + - *282 responses: '200': description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *599 + default: *602 '404': description: Not Found if project is not managed by this team x-github: @@ -94478,8 +95170,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: - - *591 - - *279 + - *594 + - *282 requestBody: required: false content: @@ -94547,8 +95239,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: - - *591 - - *279 + - *594 + - *282 responses: '204': description: Response @@ -94575,7 +95267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94585,9 +95277,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '404': *6 @@ -94617,15 +95309,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *600 + schema: *603 examples: alternative-response-with-extra-repository-information: value: @@ -94776,9 +95468,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 requestBody: required: false content: @@ -94828,9 +95520,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 responses: '204': description: Response @@ -94859,15 +95551,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: - - *591 + - *594 responses: '200': description: Response content: application/json: - schema: *282 + schema: *285 examples: - default: *283 + default: *286 '403': *27 '404': *6 x-github: @@ -94894,7 +95586,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: - - *591 + - *594 requestBody: required: true content: @@ -94955,7 +95647,7 @@ paths: description: Response content: application/json: - schema: *282 + schema: *285 examples: default: value: @@ -94986,7 +95678,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94996,9 +95688,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - response-if-child-teams-exist: *601 + response-if-child-teams-exist: *604 headers: Link: *37 '404': *6 @@ -95031,7 +95723,7 @@ paths: application/json: schema: oneOf: - - &603 + - &606 title: Private User description: Private User type: object @@ -95281,7 +95973,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *602 + - *605 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -95441,7 +96133,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *606 examples: default: value: @@ -95520,7 +96212,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '304': *35 '404': *6 '403': *27 @@ -95543,7 +96235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *154 + - *157 responses: '204': description: If the user is blocked @@ -95571,7 +96263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -95595,7 +96287,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -95644,9 +96336,9 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *35 '500': *69 '401': *23 @@ -95785,17 +96477,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -95839,7 +96531,7 @@ paths: type: integer secrets: type: array - items: &604 + items: &607 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -95881,7 +96573,7 @@ paths: - visibility - selected_repositories_url examples: - default: *386 + default: *389 headers: Link: *37 x-github: @@ -95953,13 +96645,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: - - *142 + - *145 responses: '200': description: Response content: application/json: - schema: *604 + schema: *607 examples: default: value: @@ -95989,7 +96681,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: - - *142 + - *145 requestBody: required: true content: @@ -96034,7 +96726,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -96062,7 +96754,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: - - *142 + - *145 responses: '204': description: Response @@ -96087,7 +96779,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: - - *142 + - *145 responses: '200': description: Response @@ -96103,9 +96795,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *605 + default: *608 '401': *23 '403': *27 '404': *6 @@ -96130,7 +96822,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: - - *142 + - *145 requestBody: required: true content: @@ -96184,7 +96876,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: - - *142 + - *145 - name: repository_id in: path required: true @@ -96217,7 +96909,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: - - *142 + - *145 - name: repository_id in: path required: true @@ -96249,15 +96941,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '304': *35 '500': *69 '401': *23 @@ -96283,7 +96975,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: - - *204 + - *207 requestBody: required: false content: @@ -96313,9 +97005,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -96337,9 +97029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: - '202': *120 + '202': *123 '304': *35 '500': *69 '401': *23 @@ -96366,13 +97058,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: - - *204 + - *207 responses: '202': description: Response content: application/json: - schema: &606 + schema: &609 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -96425,7 +97117,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &607 + default: &610 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -96457,7 +97149,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *204 + - *207 - name: export_id in: path required: true @@ -96470,9 +97162,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *609 examples: - default: *607 + default: *610 '404': *6 x-github: githubCloudOnly: false @@ -96493,7 +97185,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *204 + - *207 responses: '200': description: Response @@ -96509,9 +97201,9 @@ paths: type: integer machines: type: array - items: *385 + items: *388 examples: - default: *608 + default: *611 '304': *35 '500': *69 '401': *23 @@ -96540,7 +97232,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: - - *204 + - *207 requestBody: required: true content: @@ -96596,11 +97288,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *293 + repository: *296 machine: anyOf: - type: 'null' - - *385 + - *388 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -97397,15 +98089,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '304': *35 '500': *69 '400': *14 @@ -97417,7 +98109,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97437,15 +98129,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '500': *69 '401': *23 '403': *27 @@ -97475,9 +98167,9 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: &621 + default: &624 value: - id: 197 name: hello_docker @@ -97578,7 +98270,7 @@ paths: application/json: schema: type: array - items: &609 + items: &612 title: Email description: Email type: object @@ -97648,9 +98340,9 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: - default: &623 + default: &626 value: - email: octocat@github.com verified: true @@ -97727,7 +98419,7 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: default: value: @@ -97839,7 +98531,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '304': *35 @@ -97872,7 +98564,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '304': *35 @@ -97894,7 +98586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *154 + - *157 responses: '204': description: if the person is followed by the authenticated user @@ -97924,7 +98616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -97948,7 +98640,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -97984,7 +98676,7 @@ paths: application/json: schema: type: array - items: &610 + items: &613 title: GPG Key description: A unique encryption key type: object @@ -98129,7 +98821,7 @@ paths: - subkeys - revoked examples: - default: &634 + default: &637 value: - id: 3 name: Octocat's GPG Key @@ -98214,9 +98906,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *613 examples: - default: &611 + default: &614 value: id: 3 name: Octocat's GPG Key @@ -98273,7 +98965,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: - - &612 + - &615 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -98285,9 +98977,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *613 examples: - default: *611 + default: *614 '404': *6 '304': *35 '403': *27 @@ -98310,7 +99002,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: - - *612 + - *615 responses: '204': description: Response @@ -98501,7 +99193,7 @@ paths: type: array items: *55 examples: - default: *613 + default: *616 headers: Link: *37 '404': *6 @@ -98526,7 +99218,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *127 + - *130 responses: '204': description: Response @@ -98552,7 +99244,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *127 + - *130 responses: '204': description: Response @@ -98586,12 +99278,12 @@ paths: application/json: schema: anyOf: - - *193 + - *196 - type: object properties: {} additionalProperties: false examples: - default: *194 + default: *197 '204': description: Response when there are no restrictions x-github: @@ -98615,7 +99307,7 @@ paths: required: true content: application/json: - schema: *453 + schema: *456 examples: default: value: @@ -98626,7 +99318,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -98707,7 +99399,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -98720,7 +99412,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -98730,9 +99422,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: *200 + default: *203 headers: Link: *37 '404': *6 @@ -98765,7 +99457,7 @@ paths: application/json: schema: type: array - items: &614 + items: &617 title: Key description: Key type: object @@ -98863,9 +99555,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *617 examples: - default: &615 + default: &618 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98898,15 +99590,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: - - *479 + - *482 responses: '200': description: Response content: application/json: - schema: *614 + schema: *617 examples: - default: *615 + default: *618 '404': *6 '304': *35 '403': *27 @@ -98929,7 +99621,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: - - *479 + - *482 responses: '204': description: Response @@ -98962,7 +99654,7 @@ paths: application/json: schema: type: array - items: &616 + items: &619 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -99030,7 +99722,7 @@ paths: - id - type - login - plan: *101 + plan: *104 required: - billing_cycle - next_billing_date @@ -99041,7 +99733,7 @@ paths: - account - plan examples: - default: &617 + default: &620 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -99103,9 +99795,9 @@ paths: application/json: schema: type: array - items: *616 + items: *619 examples: - default: *617 + default: *620 headers: Link: *37 '304': *35 @@ -99145,7 +99837,7 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: default: value: @@ -99247,13 +99939,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -99311,7 +100003,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *114 + - *117 requestBody: required: true content: @@ -99336,7 +100028,7 @@ paths: description: Response content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -99404,7 +100096,7 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: default: value: @@ -99666,7 +100358,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -99846,7 +100538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *208 + - *211 - name: exclude in: query required: false @@ -99859,7 +100551,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -100053,7 +100745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *208 + - *211 responses: '302': description: Response @@ -100079,7 +100771,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *208 + - *211 responses: '204': description: Response @@ -100108,8 +100800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *208 - - *618 + - *211 + - *621 responses: '204': description: Response @@ -100133,7 +100825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *208 + - *211 - *17 - *18 responses: @@ -100143,9 +100835,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '404': *6 @@ -100182,7 +100874,7 @@ paths: type: array items: *50 examples: - default: *619 + default: *622 headers: Link: *37 '304': *35 @@ -100224,7 +100916,7 @@ paths: - docker - nuget - container - - *620 + - *623 - *18 - *17 responses: @@ -100234,10 +100926,10 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 - '400': *622 + default: *624 + '400': *625 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100257,16 +100949,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: - - *215 - - *216 + - *218 + - *219 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: - default: &635 + default: &638 value: id: 40201 name: octo-name @@ -100379,8 +101071,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: - - *215 - - *216 + - *218 + - *219 responses: '204': description: Response @@ -100410,8 +101102,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: - - *215 - - *216 + - *218 + - *219 - name: token description: package token schema: @@ -100443,8 +101135,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: - - *215 - - *216 + - *218 + - *219 - *18 - *17 - name: state @@ -100464,7 +101156,7 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: default: value: @@ -100513,15 +101205,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -100557,9 +101249,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '204': description: Response @@ -100589,9 +101281,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '204': description: Response @@ -100649,7 +101341,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: default: value: @@ -100718,9 +101410,9 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: - default: *623 + default: *626 headers: Link: *37 '304': *35 @@ -100833,7 +101525,7 @@ paths: type: array items: *55 examples: - default: &630 + default: &633 summary: Default response value: - id: 1296269 @@ -101149,9 +101841,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -101189,9 +101881,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *624 + default: *627 headers: Link: *37 '304': *35 @@ -101214,12 +101906,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *197 + - *200 responses: '204': description: Response '403': *27 - '409': *119 + '409': *122 '404': *6 '304': *35 x-github: @@ -101237,11 +101929,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *197 + - *200 responses: '204': description: Response - '409': *119 + '409': *122 '304': *35 '404': *6 '403': *27 @@ -101270,7 +101962,7 @@ paths: application/json: schema: type: array - items: &625 + items: &628 title: Social account description: Social media account type: object @@ -101287,7 +101979,7 @@ paths: - provider - url examples: - default: &626 + default: &629 value: - provider: twitter url: https://twitter.com/github @@ -101350,9 +102042,9 @@ paths: application/json: schema: type: array - items: *625 + items: *628 examples: - default: *626 + default: *629 '422': *15 '304': *35 '404': *6 @@ -101440,7 +102132,7 @@ paths: application/json: schema: type: array - items: &627 + items: &630 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -101460,7 +102152,7 @@ paths: - title - created_at examples: - default: &636 + default: &639 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101527,9 +102219,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *630 examples: - default: &628 + default: &631 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101560,7 +102252,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: - - &629 + - &632 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -101572,9 +102264,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *630 examples: - default: *628 + default: *631 '404': *6 '304': *35 '403': *27 @@ -101597,7 +102289,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: - - *629 + - *632 responses: '204': description: Response @@ -101626,7 +102318,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: - - &637 + - &640 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 @@ -101651,11 +102343,11 @@ paths: type: array items: *55 examples: - default-response: *630 + default-response: *633 application/vnd.github.v3.star+json: schema: type: array - items: &638 + items: &641 title: Starred Repository description: Starred Repository type: object @@ -101811,8 +102503,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response if this repository is starred by you @@ -101840,8 +102532,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -101865,8 +102557,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -101899,9 +102591,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '304': *35 @@ -101938,7 +102630,7 @@ paths: application/json: schema: type: array - items: *261 + items: *264 examples: default: value: @@ -102014,7 +102706,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *103 + - *106 responses: '200': description: Response @@ -102022,10 +102714,10 @@ paths: application/json: schema: oneOf: - - *603 - - *602 + - *606 + - *605 examples: - default-response: &632 + default-response: &635 summary: Default response value: login: octocat @@ -102060,7 +102752,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &633 + response-with-git-hub-plan-information: &636 summary: Response with GitHub plan information value: login: octocat @@ -102120,7 +102812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *631 + - *634 - *17 responses: '200': @@ -102131,7 +102823,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: example: ; rel="next" @@ -102159,7 +102851,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *154 + - *157 responses: '200': description: Response @@ -102167,11 +102859,11 @@ paths: application/json: schema: oneOf: - - *603 - - *602 + - *606 + - *605 examples: - default-response: *632 - response-with-git-hub-plan-information: *633 + default-response: *635 + response-with-git-hub-plan-information: *636 '404': *6 x-github: githubCloudOnly: false @@ -102197,7 +102889,7 @@ paths: - *17 - *63 - *64 - - *154 + - *157 - name: subject_digest description: Subject Digest in: path @@ -102299,7 +102991,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -102325,7 +103017,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *154 + - *157 responses: '200': description: Response @@ -102333,9 +103025,9 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 + default: *624 '403': *27 '401': *23 x-github: @@ -102358,7 +103050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102368,7 +103060,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102439,8 +103131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *154 - - *114 + - *157 + - *117 - *17 - *18 responses: @@ -102450,7 +103142,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102529,7 +103221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102539,7 +103231,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102606,7 +103298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102618,7 +103310,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -102637,7 +103329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102649,7 +103341,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -102668,7 +103360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *154 + - *157 - name: target_user in: path required: true @@ -102695,8 +103387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *154 - - *88 + - *157 + - *91 - *17 - *18 responses: @@ -102706,9 +103398,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '422': *15 @@ -102729,7 +103421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102739,9 +103431,9 @@ paths: application/json: schema: type: array - items: *610 + items: *613 examples: - default: *634 + default: *637 headers: Link: *37 x-github: @@ -102765,7 +103457,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *154 + - *157 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -102837,7 +103529,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *154 + - *157 responses: '200': description: Response @@ -102845,7 +103537,7 @@ paths: application/json: schema: *20 examples: - default: *452 + default: *455 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102863,7 +103555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102911,7 +103603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102923,7 +103615,7 @@ paths: type: array items: *50 examples: - default: *619 + default: *622 headers: Link: *37 x-github: @@ -102962,8 +103654,8 @@ paths: - docker - nuget - container - - *620 - - *154 + - *623 + - *157 - *18 - *17 responses: @@ -102973,12 +103665,12 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 + default: *624 '403': *27 '401': *23 - '400': *622 + '400': *625 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102998,17 +103690,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: - default: *635 + default: *638 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103029,9 +103721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '204': description: Response @@ -103063,9 +103755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 - name: token description: package token schema: @@ -103097,9 +103789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '200': description: Response @@ -103107,7 +103799,7 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: default: value: @@ -103165,16 +103857,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: - - *215 - - *216 - *218 - - *154 + - *219 + - *221 + - *157 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -103209,10 +103901,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *215 - - *216 - - *154 - *218 + - *219 + - *157 + - *221 responses: '204': description: Response @@ -103244,10 +103936,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *215 - - *216 - - *154 - *218 + - *219 + - *157 + - *221 responses: '204': description: Response @@ -103270,7 +103962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *154 + - *157 - name: state description: Indicates the state of the projects to return. in: query @@ -103291,7 +103983,7 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: default: value: @@ -103350,7 +104042,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103360,7 +104052,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -103439,7 +104131,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103449,7 +104141,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -103526,7 +104218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *154 + - *157 - name: type description: Limit results to repositories of the specified type. in: query @@ -103569,9 +104261,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -103595,15 +104287,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103625,15 +104317,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *257 + schema: *260 examples: - default: *258 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103655,15 +104347,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *259 + schema: *262 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103681,7 +104373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103691,9 +104383,9 @@ paths: application/json: schema: type: array - items: *625 + items: *628 examples: - default: *626 + default: *629 headers: Link: *37 x-github: @@ -103713,7 +104405,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103723,9 +104415,9 @@ paths: application/json: schema: type: array - items: *627 + items: *630 examples: - default: *636 + default: *639 headers: Link: *37 x-github: @@ -103749,8 +104441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *154 - - *637 + - *157 + - *640 - *65 - *17 - *18 @@ -103762,11 +104454,11 @@ paths: schema: anyOf: - type: array - items: *638 + items: *641 - type: array items: *55 examples: - default-response: *630 + default-response: *633 headers: Link: *37 x-github: @@ -103785,7 +104477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103795,9 +104487,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -103926,7 +104618,7 @@ webhooks: type: string enum: - disabled - enterprise: &639 + enterprise: &642 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -103995,7 +104687,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &640 + installation: &643 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -104016,7 +104708,7 @@ webhooks: required: - id - node_id - organization: &641 + organization: &644 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -104089,7 +104781,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &642 + repository: &645 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -104118,7 +104810,7 @@ webhooks: license: anyOf: - type: 'null' - - *99 + - *102 organization: anyOf: - type: 'null' @@ -105002,10 +105694,10 @@ webhooks: type: string enum: - enabled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -105081,11 +105773,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: &643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: &646 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) @@ -105308,11 +106000,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: *643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: *646 sender: *4 required: - action @@ -105500,11 +106192,11 @@ webhooks: - everyone required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: *643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: *646 sender: *4 required: - action @@ -105577,7 +106269,7 @@ webhooks: required: true content: application/json: - schema: &646 + schema: &649 title: Exemption request cancellation event type: object properties: @@ -105585,11 +106277,11 @@ webhooks: type: string enum: - cancelled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: &644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: &647 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -105729,7 +106421,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &645 + items: &648 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -105835,7 +106527,7 @@ webhooks: required: true content: application/json: - schema: &647 + schema: &650 title: Exemption request completed event type: object properties: @@ -105843,11 +106535,11 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 sender: *4 required: - action @@ -105919,7 +106611,7 @@ webhooks: required: true content: application/json: - schema: &648 + schema: &651 title: Exemption request created event type: object properties: @@ -105927,11 +106619,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 sender: *4 required: - action @@ -106003,7 +106695,7 @@ webhooks: required: true content: application/json: - schema: &649 + schema: &652 title: Exemption response dismissed event type: object properties: @@ -106011,12 +106703,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 - exemption_response: *645 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 + exemption_response: *648 sender: *4 required: - action @@ -106090,7 +106782,7 @@ webhooks: required: true content: application/json: - schema: &650 + schema: &653 title: Exemption response submitted event type: object properties: @@ -106098,12 +106790,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 - exemption_response: *645 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 + exemption_response: *648 sender: *4 required: - action @@ -106176,7 +106868,7 @@ webhooks: required: true content: application/json: - schema: *646 + schema: *649 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106243,7 +106935,7 @@ webhooks: required: true content: application/json: - schema: *647 + schema: *650 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106310,7 +107002,7 @@ webhooks: required: true content: application/json: - schema: *648 + schema: *651 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106377,7 +107069,7 @@ webhooks: required: true content: application/json: - schema: *649 + schema: *652 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106445,7 +107137,7 @@ webhooks: required: true content: application/json: - schema: *650 + schema: *653 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106523,7 +107215,7 @@ webhooks: type: string enum: - completed - check_run: &652 + check_run: &655 title: CheckRun description: A check performed on the code of a given code change type: object @@ -106591,8 +107283,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *350 - repository: *132 + items: *353 + repository: *135 status: type: string enum: @@ -106636,7 +107328,7 @@ webhooks: - examples: - neutral - deployment: *651 + deployment: *654 details_url: type: string examples: @@ -106696,7 +107388,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *350 + items: *353 started_at: type: string format: date-time @@ -106734,9 +107426,9 @@ webhooks: - output - app - pull_requests - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -107129,10 +107821,10 @@ webhooks: type: string enum: - created - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -107528,10 +108220,10 @@ webhooks: type: string enum: - requested_action - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 requested_action: description: The action requested by the user. type: object @@ -107936,10 +108628,10 @@ webhooks: type: string enum: - rerequested - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -108931,10 +109623,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -109619,10 +110311,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -110301,10 +110993,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -110611,20 +111303,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &653 + commit_oid: &656 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: *639 - installation: *640 - organization: *641 - ref: &654 + enterprise: *642 + installation: *643 + organization: *644 + ref: &657 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: *642 + repository: *645 sender: *4 required: - action @@ -110952,12 +111644,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111055,7 +111747,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *362 + dismissed_comment: *365 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -111230,12 +111922,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111567,12 +112259,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111841,9 +112533,9 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -111851,7 +112543,7 @@ webhooks: type: - string - 'null' - repository: *642 + repository: *645 sender: *4 required: - action @@ -112083,12 +112775,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -112350,10 +113042,10 @@ webhooks: - updated_at - author_association - body - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -112434,18 +113126,18 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *641 - pusher_type: &655 + organization: *644 + pusher_type: &658 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &656 + ref: &659 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -112455,7 +113147,7 @@ webhooks: enum: - tag - branch - repository: *642 + repository: *645 sender: *4 required: - ref @@ -112537,10 +113229,10 @@ webhooks: type: string enum: - created - definition: *227 - enterprise: *639 - installation: *640 - organization: *641 + definition: *230 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112624,9 +113316,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112702,10 +113394,10 @@ webhooks: type: string enum: - updated - definition: *227 - enterprise: *639 - installation: *640 - organization: *641 + definition: *230 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112781,19 +113473,19 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - repository: *642 - organization: *641 + enterprise: *642 + installation: *643 + repository: *645 + organization: *644 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *231 + items: *234 old_property_values: type: array description: The old custom property values for the repository. - items: *231 + items: *234 required: - action - repository @@ -112869,18 +113561,18 @@ webhooks: title: delete event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - pusher_type: *655 - ref: *656 + enterprise: *642 + installation: *643 + organization: *644 + pusher_type: *658 + ref: *659 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *642 + repository: *645 sender: *4 required: - ref @@ -112964,11 +113656,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113052,11 +113744,11 @@ webhooks: type: string enum: - auto_reopened - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113140,11 +113832,11 @@ webhooks: type: string enum: - created - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113226,11 +113918,11 @@ webhooks: type: string enum: - dismissed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113312,11 +114004,11 @@ webhooks: type: string enum: - fixed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113399,11 +114091,11 @@ webhooks: type: string enum: - reintroduced - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113485,11 +114177,11 @@ webhooks: type: string enum: - reopened - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113566,9 +114258,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - key: &657 + enterprise: *642 + installation: *643 + key: &660 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -113604,8 +114296,8 @@ webhooks: - verified - created_at - read_only - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -113682,11 +114374,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - key: *657 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + key: *660 + organization: *644 + repository: *645 sender: *4 required: - action @@ -114258,12 +114950,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: &661 + workflow: &664 title: Workflow type: - object @@ -115001,13 +115693,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *417 + deployment: *420 pull_requests: type: array - items: *498 - repository: *642 - organization: *641 - installation: *640 + items: *501 + repository: *645 + organization: *644 + installation: *643 sender: *4 responses: '200': @@ -115078,7 +115770,7 @@ webhooks: type: string enum: - approved - approver: &658 + approver: &661 type: object properties: avatar_url: @@ -115121,11 +115813,11 @@ webhooks: type: string comment: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - reviewers: &659 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + reviewers: &662 type: array items: type: object @@ -115206,7 +115898,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &660 + workflow_job_run: &663 type: object properties: conclusion: @@ -115952,18 +116644,18 @@ webhooks: type: string enum: - rejected - approver: *658 + approver: *661 comment: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - reviewers: *659 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + reviewers: *662 sender: *4 since: type: string - workflow_job_run: *660 + workflow_job_run: *663 workflow_job_runs: type: array items: @@ -116680,13 +117372,13 @@ webhooks: type: string enum: - requested - enterprise: *639 + enterprise: *642 environment: type: string - installation: *640 - organization: *641 - repository: *642 - requestor: &666 + installation: *643 + organization: *644 + repository: *645 + requestor: &669 title: User type: - object @@ -118629,12 +119321,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Deployment Workflow Run type: @@ -119325,7 +120017,7 @@ webhooks: type: string enum: - answered - answer: &664 + answer: &667 type: object properties: author_association: @@ -119485,7 +120177,7 @@ webhooks: - created_at - updated_at - body - discussion: &662 + discussion: &665 title: Discussion description: A Discussion in a repository. type: object @@ -119781,7 +120473,7 @@ webhooks: - id labels: type: array - items: *462 + items: *465 required: - repository_url - category @@ -119803,10 +120495,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -119933,11 +120625,11 @@ webhooks: - from required: - category - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120020,11 +120712,11 @@ webhooks: type: string enum: - closed - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120106,7 +120798,7 @@ webhooks: type: string enum: - created - comment: &663 + comment: &666 type: object properties: author_association: @@ -120266,11 +120958,11 @@ webhooks: - updated_at - body - reactions - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120353,12 +121045,12 @@ webhooks: type: string enum: - deleted - comment: *663 - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + comment: *666 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120453,12 +121145,12 @@ webhooks: - from required: - body - comment: *663 - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + comment: *666 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120542,11 +121234,11 @@ webhooks: type: string enum: - created - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120628,11 +121320,11 @@ webhooks: type: string enum: - deleted - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120732,11 +121424,11 @@ webhooks: type: string required: - from - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120818,10 +121510,10 @@ webhooks: type: string enum: - labeled - discussion: *662 - enterprise: *639 - installation: *640 - label: &665 + discussion: *665 + enterprise: *642 + installation: *643 + label: &668 title: Label type: object properties: @@ -120854,8 +121546,8 @@ webhooks: - color - default - description - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120938,11 +121630,11 @@ webhooks: type: string enum: - locked - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121024,11 +121716,11 @@ webhooks: type: string enum: - pinned - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121110,11 +121802,11 @@ webhooks: type: string enum: - reopened - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121199,16 +121891,16 @@ webhooks: changes: type: object properties: - new_discussion: *662 - new_repository: *642 + new_discussion: *665 + new_repository: *645 required: - new_discussion - new_repository - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121291,10 +121983,10 @@ webhooks: type: string enum: - unanswered - discussion: *662 - old_answer: *664 - organization: *641 - repository: *642 + discussion: *665 + old_answer: *667 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121376,12 +122068,12 @@ webhooks: type: string enum: - unlabeled - discussion: *662 - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121464,11 +122156,11 @@ webhooks: type: string enum: - unlocked - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121550,11 +122242,11 @@ webhooks: type: string enum: - unpinned - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121627,7 +122319,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *639 + enterprise: *642 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -122305,9 +122997,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - forkee @@ -122453,9 +123145,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pages: description: The pages that were updated. type: array @@ -122493,7 +123185,7 @@ webhooks: - action - sha - html_url - repository: *642 + repository: *645 sender: *4 required: - pages @@ -122569,10 +123261,10 @@ webhooks: type: string enum: - created - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: &667 + organization: *644 + repositories: &670 description: An array of repository objects that the installation can access. type: array @@ -122598,8 +123290,8 @@ webhooks: - name - full_name - private - repository: *642 - requester: *666 + repository: *645 + requester: *669 sender: *4 required: - action @@ -122674,11 +123366,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -122755,11 +123447,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -122836,10 +123528,10 @@ webhooks: type: string enum: - added - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories_added: &668 + organization: *644 + repositories_added: &671 description: An array of repository objects, which were added to the installation. type: array @@ -122885,15 +123577,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *642 - repository_selection: &669 + repository: *645 + repository_selection: &672 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *666 + requester: *669 sender: *4 required: - action @@ -122972,10 +123664,10 @@ webhooks: type: string enum: - removed - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories_added: *668 + organization: *644 + repositories_added: *671 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -123002,9 +123694,9 @@ webhooks: - name - full_name - private - repository: *642 - repository_selection: *669 - requester: *666 + repository: *645 + repository_selection: *672 + requester: *669 sender: *4 required: - action @@ -123083,11 +123775,11 @@ webhooks: type: string enum: - suspend - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -123270,10 +123962,10 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 target_type: type: string @@ -123352,11 +124044,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -123604,8 +124296,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124781,8 +125473,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -124862,7 +125554,7 @@ webhooks: type: string enum: - deleted - comment: &670 + comment: &673 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -125029,8 +125721,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -126204,8 +126896,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -126285,7 +126977,7 @@ webhooks: type: string enum: - edited - changes: &695 + changes: &698 description: The changes to the comment. type: object properties: @@ -126297,9 +126989,9 @@ webhooks: type: string required: - from - comment: *670 - enterprise: *639 - installation: *640 + comment: *673 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127474,8 +128166,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -127557,10 +128249,10 @@ webhooks: type: string enum: - assigned - assignee: *666 - enterprise: *639 - installation: *640 - issue: &673 + assignee: *669 + enterprise: *642 + installation: *643 + issue: &676 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128490,8 +129182,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -128571,8 +129263,8 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -129650,8 +130342,8 @@ webhooks: required: - state - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -129730,8 +130422,8 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130654,8 +131346,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -130734,8 +131426,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131662,7 +132354,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &671 + milestone: &674 title: Milestone description: A collection of related issues and pull requests. type: object @@ -131805,8 +132497,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -131905,8 +132597,8 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132836,9 +133528,9 @@ webhooks: - active_lock_reason - body - reactions - label: *665 - organization: *641 - repository: *642 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -132918,8 +133610,8 @@ webhooks: type: string enum: - labeled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133848,9 +134540,9 @@ webhooks: - active_lock_reason - body - reactions - label: *665 - organization: *641 - repository: *642 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -133930,8 +134622,8 @@ webhooks: type: string enum: - locked - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134862,8 +135554,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -134942,8 +135634,8 @@ webhooks: type: string enum: - milestoned - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135868,9 +136560,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *671 - organization: *641 - repository: *642 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -137356,8 +138048,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138286,8 +138978,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -138367,9 +139059,9 @@ webhooks: type: string enum: - pinned - enterprise: *639 - installation: *640 - issue: &672 + enterprise: *642 + installation: *643 + issue: &675 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139292,8 +139984,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -139372,8 +140064,8 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140303,8 +140995,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -141790,11 +142482,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *639 - installation: *640 - issue: *672 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *675 + organization: *644 + repository: *645 sender: *4 required: - action @@ -141875,7 +142567,7 @@ webhooks: type: string enum: - unassigned - assignee: &698 + assignee: &701 title: User type: - object @@ -141947,11 +142639,11 @@ webhooks: required: - login - id - enterprise: *639 - installation: *640 - issue: *673 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *676 + organization: *644 + repository: *645 sender: *4 required: - action @@ -142030,12 +142722,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *639 - installation: *640 - issue: *673 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *676 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -142115,8 +142807,8 @@ webhooks: type: string enum: - unlocked - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143045,8 +143737,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143126,11 +143818,11 @@ webhooks: type: string enum: - unpinned - enterprise: *639 - installation: *640 - issue: *672 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *675 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143209,11 +143901,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143291,11 +143983,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143405,11 +144097,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143491,9 +144183,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: &674 + enterprise: *642 + installation: *643 + marketplace_purchase: &677 title: Marketplace Purchase type: object required: @@ -143581,8 +144273,8 @@ webhooks: type: integer unit_count: type: integer - organization: *641 - previous_marketplace_purchase: &675 + organization: *644 + previous_marketplace_purchase: &678 title: Marketplace Purchase type: object properties: @@ -143666,7 +144358,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -143746,10 +144438,10 @@ webhooks: - changed effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143837,7 +144529,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -143919,10 +144611,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -144008,7 +144700,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -144089,8 +144781,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 marketplace_purchase: title: Marketplace Purchase type: object @@ -144176,9 +144868,9 @@ webhooks: type: integer unit_count: type: integer - organization: *641 - previous_marketplace_purchase: *675 - repository: *642 + organization: *644 + previous_marketplace_purchase: *678 + repository: *645 sender: *4 required: - action @@ -144258,12 +144950,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 - previous_marketplace_purchase: *675 - repository: *642 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 + previous_marketplace_purchase: *678 + repository: *645 sender: *4 required: - action @@ -144365,11 +145057,11 @@ webhooks: type: string required: - to - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144471,11 +145163,11 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144554,11 +145246,11 @@ webhooks: type: string enum: - removed - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144636,11 +145328,11 @@ webhooks: type: string enum: - added - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144718,7 +145410,7 @@ webhooks: required: - login - id - team: &676 + team: &679 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -144911,11 +145603,11 @@ webhooks: type: string enum: - removed - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144994,7 +145686,7 @@ webhooks: required: - login - id - team: *676 + team: *679 required: - action - scope @@ -145076,8 +145768,8 @@ webhooks: type: string enum: - checks_requested - installation: *640 - merge_group: &677 + installation: *643 + merge_group: &680 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -145096,15 +145788,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *354 + head_commit: *357 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145190,10 +145882,10 @@ webhooks: - merged - invalidated - dequeued - installation: *640 - merge_group: *677 - organization: *641 - repository: *642 + installation: *643 + merge_group: *680 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145266,7 +145958,7 @@ webhooks: type: string enum: - deleted - enterprise: *639 + enterprise: *642 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -145374,12 +146066,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *640 - organization: *641 + installation: *643 + organization: *644 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -145459,11 +146151,11 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145542,9 +146234,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - milestone: &678 + enterprise: *642 + installation: *643 + milestone: &681 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145686,8 +146378,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145766,11 +146458,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145880,11 +146572,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145964,11 +146656,11 @@ webhooks: type: string enum: - opened - enterprise: *639 - installation: *640 - milestone: *678 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *681 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146047,11 +146739,11 @@ webhooks: type: string enum: - blocked - blocked_user: *666 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + blocked_user: *669 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146130,11 +146822,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *666 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + blocked_user: *669 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146213,9 +146905,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - membership: &679 + enterprise: *642 + installation: *643 + membership: &682 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -146309,8 +147001,8 @@ webhooks: - role - organization_url - user - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146388,11 +147080,11 @@ webhooks: type: string enum: - member_added - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146471,8 +147163,8 @@ webhooks: type: string enum: - member_invited - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -146594,10 +147286,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 - user: *666 + user: *669 required: - action - invitation @@ -146675,11 +147367,11 @@ webhooks: type: string enum: - member_removed - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146766,11 +147458,11 @@ webhooks: properties: from: type: string - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146846,9 +147538,9 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 package: description: Information about the package. type: object @@ -147371,7 +148063,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &680 + items: &683 title: Ruby Gems metadata type: object properties: @@ -147468,7 +148160,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -147544,9 +148236,9 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 package: description: Information about the package. type: object @@ -147908,7 +148600,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *680 + items: *683 source_url: type: string format: uri @@ -147979,7 +148671,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -148160,12 +148852,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *639 + enterprise: *642 id: type: integer - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - id @@ -148245,7 +148937,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &681 + personal_access_token_request: &684 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -148383,10 +149075,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *639 - organization: *641 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148465,11 +149157,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *681 - enterprise: *639 - organization: *641 + personal_access_token_request: *684 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148547,11 +149239,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *681 - enterprise: *639 - organization: *641 + personal_access_token_request: *684 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148628,11 +149320,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *681 - organization: *641 - enterprise: *639 + personal_access_token_request: *684 + organization: *644 + enterprise: *642 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148736,7 +149428,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *682 + last_response: *685 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -148768,8 +149460,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 zen: description: Random string of GitHub zen. @@ -149014,10 +149706,10 @@ webhooks: - from required: - note - enterprise: *639 - installation: *640 - organization: *641 - project_card: &683 + enterprise: *642 + installation: *643 + organization: *644 + project_card: &686 title: Project Card type: object properties: @@ -149140,7 +149832,7 @@ webhooks: - creator - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -149221,11 +149913,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project_card: *683 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_card: *686 + repository: *645 sender: *4 required: - action @@ -149305,9 +149997,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 project_card: title: Project Card type: object @@ -149437,7 +150129,7 @@ webhooks: repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -149531,11 +150223,11 @@ webhooks: - from required: - note - enterprise: *639 - installation: *640 - organization: *641 - project_card: *683 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_card: *686 + repository: *645 sender: *4 required: - action @@ -149629,9 +150321,9 @@ webhooks: - from required: - column_id - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 project_card: allOf: - title: Project Card @@ -149828,7 +150520,7 @@ webhooks: type: string required: - after_id - repository: *642 + repository: *645 sender: *4 required: - action @@ -149908,10 +150600,10 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - organization: *641 - project: &685 + enterprise: *642 + installation: *643 + organization: *644 + project: &688 title: Project type: object properties: @@ -150038,7 +150730,7 @@ webhooks: - creator - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -150118,10 +150810,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project_column: &684 + enterprise: *642 + installation: *643 + organization: *644 + project_column: &687 title: Project Column type: object properties: @@ -150161,7 +150853,7 @@ webhooks: - name - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -150240,14 +150932,14 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -150336,11 +151028,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 + repository: *645 sender: *4 required: - action @@ -150420,11 +151112,11 @@ webhooks: type: string enum: - moved - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 + repository: *645 sender: *4 required: - action @@ -150504,11 +151196,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150588,14 +151280,14 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - project: *685 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -150696,11 +151388,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150779,11 +151471,11 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150864,9 +151556,9 @@ webhooks: type: string enum: - closed - installation: *640 - organization: *641 - projects_v2: &686 + installation: *643 + organization: *644 + projects_v2: &689 title: Projects v2 Project description: A projects v2 project type: object @@ -151014,9 +151706,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151097,9 +151789,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151220,9 +151912,9 @@ webhooks: type: string to: type: string - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151305,7 +151997,7 @@ webhooks: type: string enum: - archived - changes: &690 + changes: &693 type: object properties: archived_at: @@ -151321,9 +152013,9 @@ webhooks: - string - 'null' format: date-time - installation: *640 - organization: *641 - projects_v2_item: &687 + installation: *643 + organization: *644 + projects_v2_item: &690 title: Projects v2 Item description: An item belonging to a project type: object @@ -151462,9 +152154,9 @@ webhooks: - 'null' to: type: string - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151546,9 +152238,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151629,9 +152321,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151736,7 +152428,7 @@ webhooks: oneOf: - type: string - type: integer - - &688 + - &691 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -151756,7 +152448,7 @@ webhooks: required: - id - name - - &689 + - &692 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -151785,8 +152477,8 @@ webhooks: oneOf: - type: string - type: integer - - *688 - - *689 + - *691 + - *692 type: - 'null' - string @@ -151809,9 +152501,9 @@ webhooks: - 'null' required: - body - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151908,9 +152600,9 @@ webhooks: type: - string - 'null' - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151993,10 +152685,10 @@ webhooks: type: string enum: - restored - changes: *690 - installation: *640 - organization: *641 - projects_v2_item: *687 + changes: *693 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -152078,9 +152770,9 @@ webhooks: type: string enum: - reopened - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -152161,9 +152853,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2_status_update: &691 + installation: *643 + organization: *644 + projects_v2_status_update: &694 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -152298,9 +152990,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2_status_update: *691 + installation: *643 + organization: *644 + projects_v2_status_update: *694 sender: *4 required: - action @@ -152446,9 +153138,9 @@ webhooks: - string - 'null' format: date - installation: *640 - organization: *641 - projects_v2_status_update: *691 + installation: *643 + organization: *644 + projects_v2_status_update: *694 sender: *4 required: - action @@ -152519,10 +153211,10 @@ webhooks: title: public event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - repository @@ -152599,13 +153291,13 @@ webhooks: type: string enum: - assigned - assignee: *666 - enterprise: *639 - installation: *640 - number: &692 + assignee: *669 + enterprise: *642 + installation: *643 + number: &695 description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -154954,7 +155646,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -155036,11 +155728,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -157382,7 +158074,7 @@ webhooks: - draft reason: type: string - repository: *642 + repository: *645 sender: *4 required: - action @@ -157464,11 +158156,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -159810,7 +160502,7 @@ webhooks: - draft reason: type: string - repository: *642 + repository: *645 sender: *4 required: - action @@ -159892,13 +160584,13 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: &693 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: &696 allOf: - - *498 + - *501 - type: object properties: allow_auto_merge: @@ -159960,7 +160652,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *642 + repository: *645 sender: *4 required: - action @@ -160041,12 +160733,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -160126,11 +160818,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *639 - milestone: *397 - number: *692 - organization: *641 - pull_request: &694 + enterprise: *642 + milestone: *400 + number: *695 + organization: *644 + pull_request: &697 title: Pull Request type: object properties: @@ -162457,7 +163149,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -162536,11 +163228,11 @@ webhooks: type: string enum: - dequeued - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -164886,7 +165578,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *642 + repository: *645 sender: *4 required: - action @@ -165010,12 +165702,12 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -165095,11 +165787,11 @@ webhooks: type: string enum: - enqueued - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -167430,7 +168122,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -167510,11 +168202,11 @@ webhooks: type: string enum: - labeled - enterprise: *639 - installation: *640 - label: *665 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + label: *668 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -169862,7 +170554,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -169943,10 +170635,10 @@ webhooks: type: string enum: - locked - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -172292,7 +172984,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -172372,12 +173064,12 @@ webhooks: type: string enum: - milestoned - enterprise: *639 - milestone: *397 - number: *692 - organization: *641 - pull_request: *694 - repository: *642 + enterprise: *642 + milestone: *400 + number: *695 + organization: *644 + pull_request: *697 + repository: *645 sender: *4 required: - action @@ -172456,12 +173148,12 @@ webhooks: type: string enum: - opened - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -172542,12 +173234,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -172627,12 +173319,12 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -173007,9 +173699,9 @@ webhooks: - start_side - side - reactions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -175239,7 +175931,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -175319,7 +176011,7 @@ webhooks: type: string enum: - deleted - comment: &696 + comment: &699 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. @@ -175612,9 +176304,9 @@ webhooks: - start_side - side - reactions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -177832,7 +178524,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -177912,11 +178604,11 @@ webhooks: type: string enum: - edited - changes: *695 - comment: *696 - enterprise: *639 - installation: *640 - organization: *641 + changes: *698 + comment: *699 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -180137,7 +180829,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -180218,9 +180910,9 @@ webhooks: type: string enum: - dismissed - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -182453,7 +183145,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 review: description: The review that was affected. type: object @@ -182699,9 +183391,9 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -184815,8 +185507,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 - review: &697 + repository: *645 + review: &700 description: The review that was affected. type: object properties: @@ -185049,12 +185741,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -187401,7 +188093,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_reviewer: title: User type: @@ -187487,12 +188179,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -189846,7 +190538,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190041,12 +190733,12 @@ webhooks: type: string enum: - review_requested - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -192395,7 +193087,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_reviewer: title: User type: @@ -192482,12 +193174,12 @@ webhooks: type: string enum: - review_requested - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -194827,7 +195519,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195011,9 +195703,9 @@ webhooks: type: string enum: - submitted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -197249,8 +197941,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 - review: *697 + repository: *645 + review: *700 sender: *4 required: - action @@ -197330,9 +198022,9 @@ webhooks: type: string enum: - resolved - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -199463,7 +200155,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 sender: *4 thread: type: object @@ -199855,9 +200547,9 @@ webhooks: type: string enum: - unresolved - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -201971,7 +202663,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 sender: *4 thread: type: object @@ -202365,10 +203057,10 @@ webhooks: type: string before: type: string - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -204703,7 +205395,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -204785,11 +205477,11 @@ webhooks: type: string enum: - unassigned - assignee: *698 - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + assignee: *701 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -207139,7 +207831,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -207218,11 +207910,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *639 - installation: *640 - label: *665 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + label: *668 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -209561,7 +210253,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -209642,10 +210334,10 @@ webhooks: type: string enum: - unlocked - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -211974,7 +212666,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -212177,7 +212869,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *639 + enterprise: *642 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212272,8 +212964,8 @@ webhooks: - url - author - committer - installation: *640 - organization: *641 + installation: *643 + organization: *644 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212861,9 +213553,9 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 registry_package: type: object properties: @@ -213340,7 +214032,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *680 + items: *683 summary: type: string tag_name: @@ -213396,7 +214088,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -213474,9 +214166,9 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 registry_package: type: object properties: @@ -213788,7 +214480,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *680 + items: *683 summary: type: string tag_name: @@ -213838,7 +214530,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -213915,10 +214607,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - release: &699 + enterprise: *642 + installation: *643 + organization: *644 + release: &702 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -214234,7 +214926,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *642 + repository: *645 sender: *4 required: - action @@ -214311,11 +215003,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -214423,11 +215115,11 @@ webhooks: type: boolean required: - to - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -214505,9 +215197,9 @@ webhooks: type: string enum: - prereleased - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -214828,7 +215520,7 @@ webhooks: - string - 'null' format: uri - repository: *642 + repository: *645 sender: *4 required: - action @@ -214904,10 +215596,10 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - release: &700 + enterprise: *642 + installation: *643 + organization: *644 + release: &703 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -215225,7 +215917,7 @@ webhooks: - string - 'null' format: uri - repository: *642 + repository: *645 sender: *4 required: - action @@ -215301,11 +215993,11 @@ webhooks: type: string enum: - released - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -215381,11 +216073,11 @@ webhooks: type: string enum: - unpublished - enterprise: *639 - installation: *640 - organization: *641 - release: *700 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *703 + repository: *645 sender: *4 required: - action @@ -215461,11 +216153,11 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_advisory: *551 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_advisory: *554 sender: *4 required: - action @@ -215541,11 +216233,11 @@ webhooks: type: string enum: - reported - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_advisory: *551 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_advisory: *554 sender: *4 required: - action @@ -215621,10 +216313,10 @@ webhooks: type: string enum: - archived - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215701,10 +216393,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215782,10 +216474,10 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215870,10 +216562,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215988,10 +216680,10 @@ webhooks: - 'null' items: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216063,10 +216755,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 status: type: string @@ -216147,10 +216839,10 @@ webhooks: type: string enum: - privatized - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216227,10 +216919,10 @@ webhooks: type: string enum: - publicized - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216324,10 +217016,10 @@ webhooks: - name required: - repository - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216407,11 +217099,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 sender: *4 required: - action @@ -216489,11 +217181,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 sender: *4 required: - action @@ -216571,11 +217263,11 @@ webhooks: type: string enum: - edited - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 changes: type: object properties: @@ -216594,16 +217286,16 @@ webhooks: properties: added: type: array - items: *235 + items: *238 deleted: type: array - items: *235 + items: *238 updated: type: array items: type: object properties: - condition: *235 + condition: *238 changes: type: object properties: @@ -216636,16 +217328,16 @@ webhooks: properties: added: type: array - items: *240 + items: *243 deleted: type: array - items: *240 + items: *243 updated: type: array items: type: object properties: - rule: *240 + rule: *243 changes: type: object properties: @@ -216882,10 +217574,10 @@ webhooks: - from required: - owner - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216963,10 +217655,10 @@ webhooks: type: string enum: - unarchived - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217044,7 +217736,7 @@ webhooks: type: string enum: - create - alert: &701 + alert: &704 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -217168,10 +217860,10 @@ webhooks: type: string enum: - open - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217381,10 +218073,10 @@ webhooks: type: string enum: - dismissed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217462,11 +218154,11 @@ webhooks: type: string enum: - reopen - alert: *701 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217668,10 +218360,10 @@ webhooks: enum: - fixed - open - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217749,7 +218441,7 @@ webhooks: type: string enum: - created - alert: &702 + alert: &705 type: object properties: number: *70 @@ -217837,10 +218529,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217921,11 +218613,11 @@ webhooks: type: string enum: - created - alert: *702 - installation: *640 - location: *703 - organization: *641 - repository: *642 + alert: *705 + installation: *643 + location: *706 + organization: *644 + repository: *645 sender: *4 required: - location @@ -218163,11 +218855,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218245,11 +218937,11 @@ webhooks: type: string enum: - reopened - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218327,11 +219019,11 @@ webhooks: type: string enum: - resolved - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218409,11 +219101,11 @@ webhooks: type: string enum: - validated - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218489,11 +219181,11 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - security_advisory: &704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + security_advisory: &707 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218679,11 +219371,11 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - security_advisory: *704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + security_advisory: *707 sender: *4 required: - action @@ -218756,10 +219448,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218945,11 +219637,11 @@ webhooks: from: type: object properties: - security_and_analysis: *232 - enterprise: *639 - installation: *640 - organization: *641 - repository: *293 + security_and_analysis: *235 + enterprise: *642 + installation: *643 + organization: *644 + repository: *296 sender: *4 required: - changes @@ -219027,12 +219719,12 @@ webhooks: type: string enum: - cancelled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: &705 + sponsorship: &708 type: object properties: created_at: @@ -219337,12 +220029,12 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - sponsorship @@ -219430,12 +220122,12 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219512,17 +220204,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &706 + effective_date: &709 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: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - sponsorship @@ -219596,7 +220288,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &707 + changes: &710 type: object properties: tier: @@ -219640,13 +220332,13 @@ webhooks: - from required: - tier - effective_date: *706 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + effective_date: *709 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219723,13 +220415,13 @@ webhooks: type: string enum: - tier_changed - changes: *707 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + changes: *710 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219803,10 +220495,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219890,10 +220582,10 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220322,15 +221014,15 @@ webhooks: type: - string - 'null' - enterprise: *639 + enterprise: *642 id: description: The unique identifier of the status. type: integer - installation: *640 + installation: *643 name: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 sha: description: The Commit SHA. @@ -220440,15 +221132,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 + parent_issue: *101 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 - installation: *640 - organization: *641 - repository: *642 + sub_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220532,15 +221224,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 + parent_issue: *101 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 - installation: *640 - organization: *641 - repository: *642 + sub_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220624,15 +221316,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 + sub_issue: *101 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 - installation: *640 - organization: *641 - repository: *642 + parent_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220716,15 +221408,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 + sub_issue: *101 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 - installation: *640 - organization: *641 - repository: *642 + parent_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220801,12 +221493,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - team: &708 + team: &711 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220999,9 +221691,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -221471,7 +222163,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -221547,9 +222239,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -222019,7 +222711,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -222096,9 +222788,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -222568,7 +223260,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -222712,9 +223404,9 @@ webhooks: - from required: - permissions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -223184,7 +223876,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - changes @@ -223262,9 +223954,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -223734,7 +224426,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -223810,10 +224502,10 @@ webhooks: type: string enum: - started - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -223886,17 +224578,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *639 + enterprise: *642 inputs: type: - object - 'null' additionalProperties: true - installation: *640 - organization: *641 + installation: *643 + organization: *644 ref: type: string - repository: *642 + repository: *645 sender: *4 workflow: type: string @@ -223978,10 +224670,10 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: allOf: @@ -224237,7 +224929,7 @@ webhooks: type: string required: - conclusion - deployment: *417 + deployment: *420 required: - action - repository @@ -224316,10 +225008,10 @@ webhooks: type: string enum: - in_progress - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: allOf: @@ -224601,7 +225293,7 @@ webhooks: required: - status - steps - deployment: *417 + deployment: *420 required: - action - repository @@ -224680,10 +225372,10 @@ webhooks: type: string enum: - queued - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: type: object @@ -224829,7 +225521,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *417 + deployment: *420 required: - action - repository @@ -224908,10 +225600,10 @@ webhooks: type: string enum: - waiting - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: type: object @@ -225058,7 +225750,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *417 + deployment: *420 required: - action - repository @@ -225138,12 +225830,12 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object @@ -226162,12 +226854,12 @@ webhooks: type: string enum: - in_progress - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object @@ -227171,12 +227863,12 @@ webhooks: type: string enum: - requested - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 1493d193ea..a6656a4426 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -28034,6 +28034,662 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -33417,6 +34073,671 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -92388,6 +93709,662 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -161564,6 +163541,671 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot_ide_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot_dotcom_chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot_dotcom_pull_requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + } + }, + "required": [ + "date" + ], + "additionalProperties": true + } + }, + "examples": { + "default": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/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": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index c4fbd997b0..e44bf6e204 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -896,7 +896,7 @@ paths: - subscriptions_url - type - url - type: &252 + type: &255 type: string description: The type of credit the user is receiving. enum: @@ -1029,7 +1029,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &118 + schema: &121 title: Validation Error Simple description: Validation Error Simple type: object @@ -1062,7 +1062,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: - - &553 + - &556 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1593,7 +1593,7 @@ paths: schema: type: integer default: 30 - - &187 + - &190 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 @@ -1614,7 +1614,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1707,7 +1707,7 @@ paths: - installation_id - repository_id examples: - default: &189 + default: &192 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1739,7 +1739,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &563 + schema: &566 title: Scim Error description: Scim Error type: object @@ -1770,7 +1770,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &117 + schema: &120 title: Validation Error description: Validation Error type: object @@ -1842,7 +1842,7 @@ paths: description: Response content: application/json: - schema: &190 + schema: &193 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1977,7 +1977,7 @@ paths: - request - response examples: - default: &191 + default: &194 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2037,7 +2037,7 @@ paths: parameters: - *16 responses: - '202': &120 + '202': &123 description: Accepted content: application/json: @@ -2246,7 +2246,7 @@ paths: parameters: - *17 - *18 - - &88 + - &91 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) @@ -3010,7 +3010,7 @@ paths: license: anyOf: - type: 'null' - - &99 + - &102 title: License Simple description: License Simple type: object @@ -7605,7 +7605,7 @@ paths: description: Response content: application/json: - schema: &121 + schema: &124 type: object properties: total_active_caches_count: @@ -7620,7 +7620,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &122 + default: &125 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7715,7 +7715,7 @@ paths: - all - local_only - selected - selected_actions_url: &125 + selected_actions_url: &128 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` @@ -8096,7 +8096,7 @@ paths: description: Success response content: application/json: - schema: &128 + schema: &131 type: object properties: default_workflow_permissions: &44 @@ -8144,7 +8144,7 @@ paths: required: true content: application/json: - schema: &129 + schema: &132 type: object properties: default_workflow_permissions: *44 @@ -8973,7 +8973,7 @@ paths: application/json: schema: type: array - items: &133 + items: &136 title: Runner Application description: Runner Application type: object @@ -8998,7 +8998,7 @@ paths: - download_url - filename examples: - default: &134 + default: &137 value: - os: osx architecture: x64 @@ -9082,7 +9082,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &135 + '201': &138 description: Response content: application/json: @@ -9196,7 +9196,7 @@ paths: - token - expires_at examples: - default: &136 + default: &139 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9236,7 +9236,7 @@ paths: application/json: schema: *56 examples: - default: &137 + default: &140 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9268,7 +9268,7 @@ paths: application/json: schema: *53 examples: - default: &138 + default: &141 value: id: 23 name: MBP @@ -9482,7 +9482,7 @@ paths: - *38 - *52 responses: - '200': &139 + '200': &142 description: Response content: application/json: @@ -9538,7 +9538,7 @@ paths: parameters: - *38 - *52 - - &140 + - &143 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9635,7 +9635,7 @@ paths: required: true content: application/json: - schema: &147 + schema: &150 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9706,7 +9706,7 @@ paths: required: false schema: type: string - - &148 + - &151 name: include description: |- The event types to include: @@ -9724,7 +9724,7 @@ paths: - web - git - all - - &149 + - &152 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. @@ -9732,7 +9732,7 @@ paths: required: false schema: type: string - - &150 + - &153 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. @@ -9740,7 +9740,7 @@ paths: required: false schema: type: string - - &151 + - &154 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9762,7 +9762,7 @@ paths: application/json: schema: type: array - items: &152 + items: &155 type: object properties: "@timestamp": @@ -9884,7 +9884,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &153 + default: &156 value: - "@timestamp": 1606929874512 action: team.add_member @@ -9930,7 +9930,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *38 - - &155 + - &158 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`, @@ -9940,7 +9940,7 @@ paths: schema: &66 type: string description: The name of the tool used to generate the code scanning analysis. - - &156 + - &159 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 @@ -9964,7 +9964,7 @@ paths: be returned. in: query required: false - schema: &157 + schema: &160 type: string description: State of a code scanning alert. enum: @@ -9989,7 +9989,7 @@ paths: application/json: schema: type: array - items: &158 + items: &161 type: object properties: number: &70 @@ -10018,7 +10018,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &360 + instances_url: &363 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10054,7 +10054,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &361 + dismissed_reason: &364 type: - string - 'null' @@ -10065,14 +10065,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &362 + dismissed_comment: &365 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &363 + rule: &366 type: object properties: id: @@ -10133,7 +10133,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &364 + tool: &367 type: object properties: name: *66 @@ -10144,15 +10144,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *67 - most_recent_instance: &365 + most_recent_instance: &368 type: object properties: - ref: &358 + ref: &361 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &371 + analysis_key: &374 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10163,7 +10163,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &372 + category: &375 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10547,7 +10547,7 @@ paths: - most_recent_instance - repository examples: - default: &159 + default: &162 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -11202,7 +11202,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &165 + items: &168 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11217,7 +11217,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &198 + - &201 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11276,7 +11276,7 @@ paths: parent: anyOf: - type: 'null' - - &211 + - &214 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -11470,7 +11470,7 @@ paths: - created_at additionalProperties: false examples: - default: &166 + default: &169 value: total_seats: 2 seats: @@ -11552,6 +11552,487 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - *38 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &83 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions, for the given + editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true + examples: + default: &84 + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 + '500': *69 + '403': *27 + '404': *6 + '422': &85 + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: *3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -11609,7 +12090,7 @@ paths: application/json: schema: type: array - items: &83 + items: &86 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -11789,7 +12270,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &173 + - &176 name: state in: query description: |- @@ -11798,7 +12279,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &174 + - &177 name: severity in: query description: |- @@ -11807,7 +12288,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &175 + - &178 name: ecosystem in: query description: |- @@ -11816,14 +12297,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &176 + - &179 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &177 + - &180 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -11833,7 +12314,7 @@ paths: enum: - development - runtime - - &178 + - &181 name: sort in: query description: |- @@ -11849,7 +12330,7 @@ paths: - *65 - *63 - *64 - - &179 + - &182 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -11862,7 +12343,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &180 + - &183 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -11882,7 +12363,7 @@ paths: application/json: schema: type: array - items: &181 + items: &184 type: object description: A Dependabot alert. properties: @@ -11934,7 +12415,7 @@ paths: - development - runtime - - security_advisory: &409 + security_advisory: &412 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -12169,7 +12650,7 @@ paths: dismissal. maxLength: 280 fixed_at: *79 - auto_dismissed_at: &410 + auto_dismissed_at: &413 type: - string - 'null' @@ -12196,7 +12677,7 @@ paths: - repository additionalProperties: false examples: - default: &182 + default: &185 value: - number: 2 state: dismissed @@ -12602,7 +13083,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &243 + - &246 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -12613,7 +13094,7 @@ paths: enum: - open - resolved - - &244 + - &247 name: secret_type in: query description: |- @@ -12623,7 +13104,7 @@ paths: required: false schema: type: string - - &245 + - &248 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -12632,7 +13113,7 @@ paths: required: false schema: type: string - - &246 + - &249 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. @@ -12648,7 +13129,7 @@ paths: - *17 - *63 - *64 - - &247 + - &250 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -12657,7 +13138,7 @@ paths: required: false schema: type: string - - &248 + - &251 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -12666,7 +13147,7 @@ paths: schema: type: boolean default: false - - &249 + - &252 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -12682,7 +13163,7 @@ paths: application/json: schema: type: array - items: &250 + items: &253 type: object properties: number: *70 @@ -12698,14 +13179,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &546 + state: &549 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: &547 + resolution: &550 type: - string - 'null' @@ -12782,7 +13263,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &251 + default: &254 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -13019,7 +13500,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &256 type: object properties: total_minutes_used: @@ -13089,7 +13570,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &254 + default: &257 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -13127,7 +13608,7 @@ paths: description: Success content: application/json: - schema: &255 + schema: &258 type: object properties: total_advanced_security_committers: @@ -13190,7 +13671,7 @@ paths: required: - repositories examples: - default: &256 + default: &259 value: total_advanced_security_committers: 2 total_count: 2 @@ -13341,7 +13822,7 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *27 - '409': &119 + '409': &122 description: Conflict content: application/json: @@ -13433,7 +13914,7 @@ paths: description: Response content: application/json: - schema: &257 + schema: &260 type: object properties: total_gigabytes_bandwidth_used: @@ -13451,7 +13932,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &258 + default: &261 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -13483,7 +13964,7 @@ paths: description: Response content: application/json: - schema: &259 + schema: &262 type: object properties: days_left_in_billing_cycle: @@ -13501,7 +13982,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &260 + default: &263 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -13642,6 +14123,80 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - *38 + - name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -13671,7 +14226,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &210 + - &213 name: team_slug description: The slug of the team name. in: path @@ -13709,9 +14264,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: &167 + default: &170 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -13867,7 +14422,7 @@ paths: application/json: schema: type: array - items: &109 + items: &112 title: Event description: Event type: object @@ -13878,7 +14433,7 @@ paths: type: - string - 'null' - actor: &84 + actor: &87 title: Actor description: Actor type: object @@ -13919,13 +14474,13 @@ paths: - id - name - url - org: *84 + org: *87 payload: type: object properties: action: type: string - issue: &98 + issue: &101 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -14045,7 +14600,7 @@ paths: milestone: anyOf: - type: 'null' - - &397 + - &400 title: Milestone description: A collection of related issues and pull requests. @@ -14222,7 +14777,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &85 + author_association: &88 title: author_association type: string description: How the author is associated with the repository. @@ -14237,7 +14792,7 @@ paths: - OWNER examples: - OWNER - reactions: &86 + reactions: &89 title: Reaction Rollup type: object properties: @@ -14295,7 +14850,7 @@ paths: - author_association - created_at - updated_at - comment: &456 + comment: &459 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -14345,12 +14900,12 @@ paths: issue_url: type: string format: uri - author_association: *85 + author_association: *88 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - id - node_id @@ -14537,7 +15092,7 @@ paths: _links: type: object properties: - timeline: &87 + timeline: &90 title: Link With Type description: Hypermedia Link with Type type: object @@ -14549,17 +15104,17 @@ paths: required: - href - type - user: *87 - security_advisories: *87 - current_user: *87 - current_user_public: *87 - current_user_actor: *87 - current_user_organization: *87 + user: *90 + security_advisories: *90 + current_user: *90 + current_user_public: *90 + current_user_actor: *90 + current_user_organization: *90 current_user_organizations: type: array - items: *87 - repository_discussions: *87 - repository_discussions_category: *87 + items: *90 + repository_discussions: *90 + repository_discussions_category: *90 required: - timeline - user @@ -14621,7 +15176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *88 + - *91 - *17 - *18 responses: @@ -14631,7 +15186,7 @@ paths: application/json: schema: type: array - items: &89 + items: &92 title: Base Gist description: Base Gist type: object @@ -14721,7 +15276,7 @@ paths: - created_at - updated_at examples: - default: &90 + default: &93 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -14845,7 +15400,7 @@ paths: description: Response content: application/json: - schema: &91 + schema: &94 title: Gist Simple description: Gist Simple type: object @@ -14863,7 +15418,7 @@ paths: url: type: string format: uri - user: &602 + user: &605 title: Public User description: Public User type: object @@ -15228,7 +15783,7 @@ paths: truncated: type: boolean examples: - default: &92 + default: &95 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -15330,7 +15885,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *88 + - *91 - *17 - *18 responses: @@ -15340,9 +15895,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '422': *15 @@ -15364,7 +15919,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *88 + - *91 - *17 - *18 responses: @@ -15374,9 +15929,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '401': *23 @@ -15404,7 +15959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &93 + - &96 name: gist_id description: The unique identifier of the gist. in: path @@ -15416,10 +15971,10 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - default: *92 - '403': &96 + default: *95 + '403': &99 description: Forbidden Gist content: application/json: @@ -15468,7 +16023,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *93 + - *96 requestBody: required: true content: @@ -15532,9 +16087,9 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - updateGist: *92 + updateGist: *95 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -15692,7 +16247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -15721,7 +16276,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *93 + - *96 - *17 - *18 responses: @@ -15731,7 +16286,7 @@ paths: application/json: schema: type: array - items: &94 + items: &97 title: Gist Comment description: A comment made to a gist. type: object @@ -15769,7 +16324,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *85 + author_association: *88 required: - url - id @@ -15834,7 +16389,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *93 + - *96 requestBody: required: true content: @@ -15860,9 +16415,9 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: &95 + default: &98 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -15920,8 +16475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *93 - - &97 + - *96 + - &100 name: comment_id description: The unique identifier of the comment. in: path @@ -15934,12 +16489,12 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: *95 + default: *98 '304': *35 '404': *6 - '403': *96 + '403': *99 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15961,8 +16516,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *93 - - *97 + - *96 + - *100 requestBody: required: true content: @@ -15988,9 +16543,9 @@ paths: description: Response content: application/json: - schema: *94 + schema: *97 examples: - default: *95 + default: *98 '404': *6 x-github: githubCloudOnly: false @@ -16007,8 +16562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *93 - - *97 + - *96 + - *100 responses: '204': description: Response @@ -16031,7 +16586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *93 + - *96 - *17 - *18 responses: @@ -16132,7 +16687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *93 + - *96 - *17 - *18 responses: @@ -16142,7 +16697,7 @@ paths: application/json: schema: type: array - items: *91 + items: *94 examples: default: value: @@ -16207,13 +16762,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *93 + - *96 responses: '201': description: Response content: application/json: - schema: *89 + schema: *92 examples: default: value: @@ -16284,7 +16839,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *93 + - *96 responses: '204': description: Response if gist is starred @@ -16314,7 +16869,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -16336,7 +16891,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *93 + - *96 responses: '204': description: Response @@ -16365,7 +16920,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *93 + - *96 - name: sha in: path required: true @@ -16376,9 +16931,9 @@ paths: description: Response content: application/json: - schema: *91 + schema: *94 examples: - default: *92 + default: *95 '422': *15 '404': *6 '403': *27 @@ -16747,7 +17302,7 @@ paths: - closed - all default: open - - &199 + - &202 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16766,7 +17321,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - name: collab in: query required: false @@ -16796,9 +17351,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: &200 + default: &203 value: - id: 1 node_id: MDU6SXNzdWUx @@ -17078,7 +17633,7 @@ paths: application/json: schema: type: array - items: *99 + items: *102 examples: default: value: @@ -17375,7 +17930,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &100 + X-CommonMarker-Version: &103 example: 0.17.4 schema: type: string @@ -17430,7 +17985,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *100 + X-CommonMarker-Version: *103 content: text/html: schema: @@ -17459,7 +18014,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: - - &103 + - &106 name: account_id description: account_id parameter in: path @@ -17471,7 +18026,7 @@ paths: description: Response content: application/json: - schema: &102 + schema: &105 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -17505,7 +18060,7 @@ paths: - 'null' id: type: integer - plan: &101 + plan: &104 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -17608,7 +18163,7 @@ paths: - 'null' updated_at: type: string - plan: *101 + plan: *104 required: - url - id @@ -17616,7 +18171,7 @@ paths: - login - marketplace_purchase examples: - default: &104 + default: &107 value: url: https://api.github.com/orgs/github type: Organization @@ -17701,9 +18256,9 @@ paths: application/json: schema: type: array - items: *101 + items: *104 examples: - default: &105 + default: &108 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -17743,14 +18298,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &106 + - &109 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &107 + - &110 name: sort description: The property to sort the results by. in: query @@ -17780,9 +18335,9 @@ paths: application/json: schema: type: array - items: *102 + items: *105 examples: - default: &108 + default: &111 value: - url: https://api.github.com/orgs/github type: Organization @@ -17856,15 +18411,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: - - *103 + - *106 responses: '200': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *104 + default: *107 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -17896,9 +18451,9 @@ paths: application/json: schema: type: array - items: *101 + items: *104 examples: - default: *105 + default: *108 headers: Link: *37 '401': *23 @@ -17921,8 +18476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *106 - - *107 + - *109 + - *110 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -17942,9 +18497,9 @@ paths: application/json: schema: type: array - items: *102 + items: *105 examples: - default: *108 + default: *111 headers: Link: *37 '401': *23 @@ -18194,14 +18749,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: - - &280 + - &283 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &281 + - &284 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -18218,7 +18773,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -18272,7 +18827,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &294 + '301': &297 description: Moved permanently content: application/json: @@ -18294,7 +18849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &484 + - &487 name: all description: If `true`, show notifications marked as read. in: query @@ -18302,7 +18857,7 @@ paths: schema: type: boolean default: false - - &485 + - &488 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -18311,8 +18866,8 @@ paths: schema: type: boolean default: false - - *88 - - &486 + - *91 + - &489 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: @@ -18337,14 +18892,14 @@ paths: application/json: schema: type: array - items: &110 + items: &113 title: Thread description: Thread type: object properties: id: type: string - repository: &132 + repository: &135 title: Minimal Repository description: Minimal Repository type: object @@ -18683,7 +19238,7 @@ paths: type: boolean examples: - false - security_and_analysis: &232 + security_and_analysis: &235 type: - object - 'null' @@ -18838,7 +19393,7 @@ paths: - url - subscription_url examples: - default: &487 + default: &490 value: - id: '1' repository: @@ -19004,7 +19559,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &111 + - &114 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 @@ -19018,7 +19573,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *113 examples: default: value: @@ -19121,7 +19676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *111 + - *114 responses: '205': description: Reset Content @@ -19144,7 +19699,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *111 + - *114 responses: '204': description: No content @@ -19167,13 +19722,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: - - *111 + - *114 responses: '200': description: Response content: application/json: - schema: &112 + schema: &115 title: Thread Subscription description: Thread Subscription type: object @@ -19217,7 +19772,7 @@ paths: - url - subscribed examples: - default: &113 + default: &116 value: subscribed: true ignored: false @@ -19248,7 +19803,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *111 + - *114 requestBody: required: false content: @@ -19269,9 +19824,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *113 + default: *116 '304': *35 '403': *27 '401': *23 @@ -19294,7 +19849,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *111 + - *114 responses: '204': description: Response @@ -19391,7 +19946,7 @@ paths: type: array items: *50 examples: - default: &619 + default: &622 value: - login: github id: 1 @@ -19456,7 +20011,7 @@ paths: - 3 custom_roles: type: array - items: &168 + items: &171 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -19505,7 +20060,7 @@ paths: - created_at - updated_at examples: - default: &169 + default: &172 value: id: 8030 name: Security Engineer @@ -19557,7 +20112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - &114 + - &117 name: org description: The organization name. The name is not case sensitive. in: path @@ -19569,7 +20124,7 @@ paths: description: Response content: application/json: - schema: &115 + schema: &118 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -19932,7 +20487,7 @@ paths: - updated_at - archived_at examples: - default-response: &116 + default-response: &119 value: login: github id: 1 @@ -20024,7 +20579,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *114 + - *117 requestBody: required: false content: @@ -20244,18 +20799,18 @@ paths: description: Response content: application/json: - schema: *115 + schema: *118 examples: - default: *116 + default: *119 '422': description: Validation failed content: application/json: schema: oneOf: - - *117 - - *118 - '409': *119 + - *120 + - *121 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20278,9 +20833,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *114 + - *117 responses: - '202': *120 + '202': *123 '404': *6 '403': *27 x-github: @@ -20303,15 +20858,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *121 + schema: *124 examples: - default: *122 + default: *125 headers: Link: *37 x-github: @@ -20334,7 +20889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -20352,7 +20907,7 @@ paths: type: integer repository_cache_usages: type: array - items: &299 + items: &302 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -20410,13 +20965,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#get-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *114 + - *117 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &123 + schema: &126 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -20430,7 +20985,7 @@ paths: required: - include_claim_keys examples: - default: &124 + default: &127 value: include_claim_keys: - repo @@ -20452,20 +21007,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: *123 + schema: *126 examples: - default: *124 + default: *127 responses: '201': description: Empty response content: application/json: - schema: &143 + schema: &146 title: Empty Object description: An object without any properties. type: object @@ -20495,7 +21050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -20504,7 +21059,7 @@ paths: schema: type: object properties: - enabled_repositories: &126 + enabled_repositories: &129 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -20518,7 +21073,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *40 - selected_actions_url: *125 + selected_actions_url: *128 required: - enabled_repositories examples: @@ -20547,7 +21102,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20558,7 +21113,7 @@ paths: schema: type: object properties: - enabled_repositories: *126 + enabled_repositories: *129 allowed_actions: *40 required: - enabled_repositories @@ -20586,7 +21141,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#list-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -20606,7 +21161,7 @@ paths: type: array items: *55 examples: - default: &613 + default: &616 value: total_count: 1 repositories: @@ -20746,7 +21301,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-selected-repositories-enabled-for-github-actions-in-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20790,8 +21345,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#enable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *114 - - &127 + - *117 + - &130 name: repository_id description: The unique identifier of the repository. in: path @@ -20819,8 +21374,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization parameters: - - *114 - - *127 + - *117 + - *130 responses: '204': description: Response @@ -20843,7 +21398,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -20874,7 +21429,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -20906,13 +21461,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: default: *46 x-github: @@ -20935,7 +21490,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Success response @@ -20946,7 +21501,7 @@ paths: required: false content: application/json: - schema: *129 + schema: *132 examples: default: *46 x-github: @@ -20968,7 +21523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization parameters: - - *114 + - *117 - *17 - *18 - name: visible_to_repository @@ -20993,7 +21548,7 @@ paths: type: number runner_groups: type: array - items: &130 + items: &133 type: object properties: id: @@ -21106,7 +21661,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -21176,9 +21731,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: &131 + default: &134 value: id: 2 name: octo-runner-group @@ -21213,14 +21768,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 - *49 responses: '200': description: Response content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -21256,7 +21811,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21308,9 +21863,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: *131 + default: *134 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21329,7 +21884,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization parameters: - - *114 + - *117 - *49 responses: '204': @@ -21353,7 +21908,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - *18 - *17 @@ -21372,9 +21927,9 @@ paths: type: number repositories: type: array - items: *132 + items: *135 examples: - default: &605 + default: &608 value: total_count: 1 repositories: @@ -21626,7 +22181,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21671,9 +22226,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - - *127 + - *130 responses: '204': description: Response @@ -21695,9 +22250,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization parameters: - - *114 + - *117 - *49 - - *127 + - *130 responses: '204': description: Response @@ -21720,7 +22275,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *17 - *18 @@ -21762,7 +22317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization parameters: - - *114 + - *117 - *49 requestBody: required: true @@ -21807,7 +22362,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *52 responses: @@ -21831,7 +22386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization parameters: - - *114 + - *117 - *49 - *52 responses: @@ -21863,7 +22418,7 @@ paths: in: query schema: type: string - - *114 + - *117 - *17 - *18 responses: @@ -21907,7 +22462,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -21915,9 +22470,9 @@ paths: application/json: schema: type: array - items: *133 + items: *136 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21939,7 +22494,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -21982,7 +22537,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *135 + '201': *138 '404': *6 '422': *7 x-github: @@ -22012,7 +22567,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *114 + - *117 responses: '201': description: Response @@ -22020,7 +22575,7 @@ paths: application/json: schema: *56 examples: - default: *136 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22048,7 +22603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *114 + - *117 responses: '201': description: Response @@ -22056,7 +22611,7 @@ paths: application/json: schema: *56 examples: - default: *137 + default: *140 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22078,7 +22633,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: '200': @@ -22087,7 +22642,7 @@ paths: application/json: schema: *53 examples: - default: *138 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22108,7 +22663,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization parameters: - - *114 + - *117 - *52 responses: '204': @@ -22134,7 +22689,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: '200': *58 @@ -22159,7 +22714,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 requestBody: required: true @@ -22208,7 +22763,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 requestBody: required: true @@ -22258,10 +22813,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 responses: - '200': *139 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -22288,9 +22843,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization parameters: - - *114 + - *117 - *52 - - *140 + - *143 responses: '200': *58 '404': *6 @@ -22317,7 +22872,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -22335,7 +22890,7 @@ paths: type: integer secrets: type: array - items: &141 + items: &144 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22410,13 +22965,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &319 + schema: &322 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22451,7 +23006,7 @@ paths: - key_id - key examples: - default: &320 + default: &323 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22476,8 +23031,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *114 - - &142 + - *117 + - &145 name: secret_name description: The name of the secret. in: path @@ -22489,7 +23044,7 @@ paths: description: Response content: application/json: - schema: *141 + schema: *144 examples: default: value: @@ -22519,8 +23074,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -22575,7 +23130,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -22601,8 +23156,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -22628,8 +23183,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -22647,9 +23202,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: &146 + default: &149 value: total_count: 1 repositories: @@ -22741,8 +23296,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -22794,8 +23349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -22828,8 +23383,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -22861,8 +23416,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *114 - - &304 + - *117 + - &307 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)." @@ -22886,7 +23441,7 @@ paths: type: integer variables: type: array - items: &144 + items: &147 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22976,7 +23531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *114 + - *117 requestBody: required: true content: @@ -23024,7 +23579,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -23049,8 +23604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *114 - - &145 + - *117 + - &148 name: name description: The name of the variable. in: path @@ -23062,7 +23617,7 @@ paths: description: Response content: application/json: - schema: *144 + schema: *147 examples: default: value: @@ -23092,8 +23647,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 requestBody: required: true content: @@ -23155,8 +23710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 responses: '204': description: Response @@ -23182,8 +23737,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - *18 - *17 responses: @@ -23201,9 +23756,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23229,8 +23784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 requestBody: required: true content: @@ -23279,8 +23834,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - name: repository_id in: path required: true @@ -23314,8 +23869,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *114 - - *145 + - *117 + - *148 - name: repository_id in: path required: true @@ -23346,7 +23901,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -23373,11 +23928,11 @@ paths: required: true content: application/json: - schema: *147 + schema: *150 examples: default: *61 parameters: - - *114 + - *117 responses: '200': description: Response @@ -23401,7 +23956,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -23429,7 +23984,7 @@ paths: - *17 - *63 - *64 - - *114 + - *117 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -23470,7 +24025,7 @@ paths: repository_id: type: integer examples: - default: &333 + default: &336 value: attestations: - bundle: @@ -23588,7 +24143,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-the-audit-log-for-an-organization parameters: - - *114 + - *117 - name: phrase description: A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). @@ -23596,10 +24151,10 @@ paths: required: false schema: type: string - - *148 - - *149 - - *150 - *151 + - *152 + - *153 + - *154 - *17 responses: '200': @@ -23608,9 +24163,9 @@ paths: application/json: schema: type: array - items: *152 + items: *155 examples: - default: *153 + default: *156 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -23627,7 +24182,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -23639,7 +24194,7 @@ paths: type: array items: *4 examples: - default: &201 + default: &204 value: - login: octocat id: 1 @@ -23677,8 +24232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *114 - - &154 + - *117 + - &157 name: username description: The handle for the GitHub user account. in: path @@ -23709,8 +24264,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -23730,8 +24285,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -23756,9 +24311,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *114 - - *155 - - *156 + - *117 + - *158 + - *159 - *63 - *64 - *18 @@ -23769,7 +24324,7 @@ paths: be returned. in: query required: false - schema: *157 + schema: *160 - name: sort description: The property by which to sort the results. in: query @@ -23785,7 +24340,7 @@ paths: be returned. in: query required: false - schema: &359 + schema: &362 type: string description: Severity of a code scanning alert. enum: @@ -23803,9 +24358,9 @@ paths: application/json: schema: type: array - items: *158 + items: *161 examples: - default: *159 + default: *162 headers: Link: *37 '404': *6 @@ -23831,7 +24386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *114 + - *117 - name: target_type in: query description: The target type of the code security configuration @@ -23859,7 +24414,7 @@ paths: application/json: schema: type: array - items: &160 + items: &163 type: object description: A code security configuration properties: @@ -24098,7 +24653,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *114 + - *117 requestBody: required: true content: @@ -24270,9 +24825,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *160 + schema: *163 examples: - default: &161 + default: &164 value: id: 1325 target_type: organization @@ -24318,7 +24873,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *114 + - *117 responses: '200': description: Response @@ -24338,7 +24893,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *160 + configuration: *163 examples: default: value: @@ -24422,7 +24977,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *114 + - *117 requestBody: required: true content: @@ -24445,12 +25000,12 @@ paths: - 32 - 91 responses: - '204': &163 + '204': &166 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24472,8 +25027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *114 - - &162 + - *117 + - &165 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -24485,9 +25040,9 @@ paths: description: Response content: application/json: - schema: *160 + schema: *163 examples: - default: *161 + default: *164 '304': *35 '403': *27 '404': *6 @@ -24511,8 +25066,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24664,7 +25219,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *160 + schema: *163 examples: default: value: @@ -24715,14 +25270,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 responses: - '204': *163 + '204': *166 '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24746,8 +25301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24786,7 +25341,7 @@ paths: - 32 - 91 responses: - '202': *120 + '202': *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24810,8 +25365,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization parameters: - - *114 - - *162 + - *117 + - *165 requestBody: required: true content: @@ -24851,12 +25406,12 @@ paths: - none - private_and_internal - public - configuration: *160 + configuration: *163 examples: default: value: default_for_new_repos: all - configuration: *161 + configuration: *164 '403': *27 '404': *6 x-github: @@ -24880,8 +25435,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *114 - - *162 + - *117 + - *165 - 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)." @@ -25024,7 +25579,7 @@ paths: parameters: - *17 - *18 - - *114 + - *117 responses: '200': description: Response @@ -25040,7 +25595,7 @@ paths: type: integer codespaces: type: array - items: &202 + items: &205 type: object title: Codespace description: A codespace. @@ -25071,11 +25626,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *132 + repository: *135 machine: anyOf: - type: 'null' - - &385 + - &388 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -25362,7 +25917,7 @@ paths: - pulls_url - recent_folders examples: - default: &203 + default: &206 value: total_count: 3 codespaces: @@ -25794,7 +26349,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *114 + - *117 deprecated: true requestBody: required: true @@ -25861,7 +26416,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *114 + - *117 deprecated: true requestBody: required: true @@ -25916,7 +26471,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *114 + - *117 requestBody: required: true content: @@ -25968,7 +26523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -25986,7 +26541,7 @@ paths: type: integer secrets: type: array - items: &164 + items: &167 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -26027,7 +26582,7 @@ paths: - updated_at - visibility examples: - default: &386 + default: &389 value: total_count: 2 secrets: @@ -26059,13 +26614,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &387 + schema: &390 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -26100,7 +26655,7 @@ paths: - key_id - key examples: - default: &388 + default: &391 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -26123,16 +26678,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '200': description: Response content: application/json: - schema: *164 + schema: *167 examples: - default: &390 + default: &393 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -26159,8 +26714,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -26215,7 +26770,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -26241,8 +26796,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -26267,8 +26822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -26286,9 +26841,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 '404': *6 x-github: githubCloudOnly: false @@ -26310,8 +26865,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -26361,8 +26916,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -26395,8 +26950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -26435,7 +26990,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - - *114 + - *117 responses: '200': description: OK @@ -26575,7 +27130,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - - *114 + - *117 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -26598,9 +27153,9 @@ paths: currently being billed. seats: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 headers: Link: *37 '500': *69 @@ -26638,7 +27193,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26716,7 +27271,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26797,7 +27352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26875,7 +27430,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - - *114 + - *117 requestBody: content: application/json: @@ -26931,6 +27486,74 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - *117 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -26956,7 +27579,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members parameters: - - *114 + - *117 - 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`). @@ -26988,9 +27611,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: *167 + default: *170 '500': *69 '401': *23 '403': *27 @@ -27016,7 +27639,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -27175,7 +27798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization parameters: - - *114 + - *117 - name: credential_id in: path required: true @@ -27206,7 +27829,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization parameters: - - *114 + - *117 responses: '200': description: Response - list of custom role names @@ -27222,7 +27845,7 @@ paths: - 3 custom_roles: type: array - items: *168 + items: *171 examples: default: value: @@ -27309,12 +27932,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: &171 + schema: &174 type: object properties: name: @@ -27356,9 +27979,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27382,8 +28005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *114 - - &170 + - *117 + - &173 name: role_id description: The unique identifier of the role. in: path @@ -27395,9 +28018,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '404': *6 x-github: githubCloudOnly: true @@ -27419,13 +28042,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: application/json: - schema: &172 + schema: &175 type: object properties: name: @@ -27464,9 +28087,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27490,8 +28113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -27519,12 +28142,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---create-a-custom-role parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: *171 + schema: *174 examples: default: value: @@ -27538,9 +28161,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27570,16 +28193,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---get-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '200': description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '404': *6 x-github: githubCloudOnly: true @@ -27607,13 +28230,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---update-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: application/json: - schema: *172 + schema: *175 examples: default: value: @@ -27628,9 +28251,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *171 examples: - default: *169 + default: *172 '422': *15 '404': *6 x-github: @@ -27660,8 +28283,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---delete-a-custom-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -27689,18 +28312,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *114 - - *173 - - *174 - - *175 + - *117 - *176 - *177 - *178 + - *179 + - *180 + - *181 - *65 - *63 - *64 - - *179 - - *180 + - *182 + - *183 - *17 responses: '200': @@ -27709,9 +28332,9 @@ paths: application/json: schema: type: array - items: *181 + items: *184 examples: - default: *182 + default: *185 '304': *35 '400': *14 '403': *27 @@ -27737,7 +28360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *114 + - *117 - *17 - *18 responses: @@ -27755,7 +28378,7 @@ paths: type: integer secrets: type: array - items: &183 + items: &186 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27828,13 +28451,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: &413 + schema: &416 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27853,7 +28476,7 @@ paths: - key_id - key examples: - default: &414 + default: &417 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27876,14 +28499,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '200': description: Response content: application/json: - schema: *183 + schema: *186 examples: default: value: @@ -27911,8 +28534,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -27967,7 +28590,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -27991,8 +28614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 responses: '204': description: Response @@ -28016,8 +28639,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - *18 - *17 responses: @@ -28035,9 +28658,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *146 + default: *149 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28058,8 +28681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 requestBody: required: true content: @@ -28109,8 +28732,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -28141,8 +28764,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *114 - - *142 + - *117 + - *145 - name: repository_id in: path required: true @@ -28172,7 +28795,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -28180,7 +28803,7 @@ paths: application/json: schema: type: array - items: &213 + items: &216 title: Package description: A software package type: object @@ -28233,7 +28856,7 @@ paths: repository: anyOf: - type: 'null' - - *132 + - *135 created_at: type: string format: date-time @@ -28251,7 +28874,7 @@ paths: - created_at - updated_at examples: - default: &214 + default: &217 value: - id: 197 name: hello_docker @@ -28329,7 +28952,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28339,7 +28962,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: 200-response: value: @@ -28409,7 +29032,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *114 + - *117 - name: group_id description: The unique identifier of the group. in: path @@ -28435,7 +29058,7 @@ paths: description: Response content: application/json: - schema: &275 + schema: &278 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -28525,7 +29148,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &276 + default: &279 value: group_id: '123' group_name: Octocat admins @@ -28563,7 +29186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-external-groups-in-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -28580,7 +29203,7 @@ paths: description: Response content: application/json: - schema: &273 + schema: &276 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -28620,7 +29243,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &274 + default: &277 value: groups: - group_id: '123' @@ -28654,7 +29277,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28664,7 +29287,7 @@ paths: application/json: schema: type: array - items: &195 + items: &198 title: Organization Invitation description: Organization Invitation type: object @@ -28718,7 +29341,7 @@ paths: - invitation_teams_url - node_id examples: - default: &196 + default: &199 value: - id: 1 login: monalisa @@ -28777,7 +29400,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#closing-down---list-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -28785,7 +29408,7 @@ paths: application/json: schema: type: array - items: &233 + items: &236 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -28799,7 +29422,7 @@ paths: - name - description examples: - default: &234 + default: &237 value: - name: add_assignee description: Assign or remove a user @@ -28830,7 +29453,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *114 + - *117 - *17 - *18 responses: @@ -28840,7 +29463,7 @@ paths: application/json: schema: type: array - items: &184 + items: &187 title: Org Hook description: Org Hook type: object @@ -28961,7 +29584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *114 + - *117 requestBody: required: true content: @@ -29023,9 +29646,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: &185 + default: &188 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -29069,8 +29692,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *114 - - &186 + - *117 + - &189 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. @@ -29083,9 +29706,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: *185 + default: *188 '404': *6 x-github: githubCloudOnly: false @@ -29106,8 +29729,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 requestBody: required: false content: @@ -29153,7 +29776,7 @@ paths: description: Response content: application/json: - schema: *184 + schema: *187 examples: default: value: @@ -29192,8 +29815,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 responses: '204': description: Response @@ -29218,8 +29841,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *114 - - *186 + - *117 + - *189 responses: '200': description: Response @@ -29247,8 +29870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *114 - - *186 + - *117 + - *189 requestBody: required: false content: @@ -29296,10 +29919,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *17 - - *187 + - *190 - name: redelivery in: query required: false @@ -29312,9 +29935,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '400': *14 '422': *15 x-github: @@ -29337,17 +29960,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: - default: *191 + default: *194 '400': *14 '422': *15 x-github: @@ -29370,11 +29993,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 - *16 responses: - '202': *120 + '202': *123 '400': *14 '422': *15 x-github: @@ -29397,8 +30020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *114 - - *186 + - *117 + - *189 responses: '204': description: Response @@ -29422,7 +30045,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *114 + - *117 responses: '200': description: Response @@ -29430,7 +30053,7 @@ paths: application/json: schema: *20 examples: - default: &452 + default: &455 value: id: 1 account: @@ -29499,7 +30122,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -29588,7 +30211,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -29596,12 +30219,12 @@ paths: application/json: schema: anyOf: - - &193 + - &196 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &192 + limit: &195 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -29629,7 +30252,7 @@ paths: properties: {} additionalProperties: false examples: - default: &194 + default: &197 value: limit: collaborators_only origin: organization @@ -29653,18 +30276,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: application/json: - schema: &453 + schema: &456 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *192 + limit: *195 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -29689,9 +30312,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *194 + default: *197 '422': *15 x-github: githubCloudOnly: false @@ -29709,7 +30332,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *114 + - *117 responses: '204': description: Response @@ -29735,7 +30358,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *114 + - *117 - *17 - *18 - name: role @@ -29769,9 +30392,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 '404': *6 @@ -29795,7 +30418,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *114 + - *117 requestBody: required: false content: @@ -29849,7 +30472,7 @@ paths: description: Response content: application/json: - schema: *195 + schema: *198 examples: default: value: @@ -29905,8 +30528,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *114 - - &197 + - *117 + - &200 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29939,8 +30562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *114 - - *197 + - *117 + - *200 - *17 - *18 responses: @@ -29950,9 +30573,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: &212 + default: &215 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29997,7 +30620,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *114 + - *117 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -30027,7 +30650,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -30040,7 +30663,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -30050,9 +30673,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: *200 + default: *203 headers: Link: *37 '404': *6 @@ -30074,7 +30697,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *114 + - *117 - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -30110,7 +30733,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '422': *15 @@ -30130,8 +30753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response if requester is an organization member and user is @@ -30162,8 +30785,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -30189,8 +30812,8 @@ paths: parameters: - *17 - *18 - - *114 - - *154 + - *117 + - *157 responses: '200': description: Response @@ -30206,9 +30829,9 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *35 '500': *69 '401': *23 @@ -30233,9 +30856,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *114 - - *154 - - &204 + - *117 + - *157 + - &207 name: codespace_name in: path required: true @@ -30243,7 +30866,7 @@ paths: schema: type: string responses: - '202': *120 + '202': *123 '304': *35 '500': *69 '401': *23 @@ -30268,17 +30891,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *114 - - *154 - - *204 + - *117 + - *157 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: &384 + default: &387 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -30448,14 +31071,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *165 + schema: *168 examples: default: value: @@ -30523,14 +31146,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '200': description: Response content: application/json: - schema: &205 + schema: &208 title: Org Membership description: Org Membership type: object @@ -30583,7 +31206,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &206 + response-if-user-has-an-active-admin-membership-with-organization: &209 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -30651,8 +31274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 requestBody: required: false content: @@ -30680,9 +31303,9 @@ paths: description: Response content: application/json: - schema: *205 + schema: *208 examples: - response-if-user-already-had-membership-with-organization: *206 + response-if-user-already-had-membership-with-organization: *209 '422': *15 '403': *27 x-github: @@ -30703,8 +31326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -30729,7 +31352,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *114 + - *117 - *17 - *18 - name: exclude @@ -30751,7 +31374,7 @@ paths: application/json: schema: type: array - items: &207 + items: &210 title: Migration description: A migration. type: object @@ -31008,7 +31631,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *114 + - *117 requestBody: required: true content: @@ -31089,7 +31712,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -31267,8 +31890,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *114 - - &208 + - *117 + - &211 name: migration_id description: The unique identifier of the migration. in: path @@ -31296,7 +31919,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -31465,8 +32088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *114 - - *208 + - *117 + - *211 responses: '302': description: Response @@ -31487,8 +32110,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *114 - - *208 + - *117 + - *211 responses: '204': description: Response @@ -31511,9 +32134,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *114 - - *208 - - &618 + - *117 + - *211 + - &621 name: repo_name description: repo_name parameter in: path @@ -31540,8 +32163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *114 - - *208 + - *117 + - *211 - *17 - *18 responses: @@ -31551,9 +32174,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: &219 + default: &222 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -31692,7 +32315,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -31746,7 +32369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response - list of organization roles @@ -31762,7 +32385,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &209 + items: &212 title: Organization Role description: Organization roles type: object @@ -31900,7 +32523,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *114 + - *117 requestBody: required: true content: @@ -31947,7 +32570,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -31976,7 +32599,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -31998,8 +32621,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -32024,9 +32647,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *114 - - *210 - - *170 + - *117 + - *213 + - *173 responses: '204': description: Response @@ -32055,9 +32678,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *114 - - *210 - - *170 + - *117 + - *213 + - *173 responses: '204': description: Response @@ -32082,8 +32705,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -32108,9 +32731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *114 - - *154 - - *170 + - *117 + - *157 + - *173 responses: '204': description: Response @@ -32140,9 +32763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *114 - - *154 - - *170 + - *117 + - *157 + - *173 responses: '204': description: Response @@ -32170,14 +32793,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '200': description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -32234,8 +32857,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *114 - - *170 + - *117 + - *173 requestBody: required: true content: @@ -32274,7 +32897,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *212 examples: default: value: @@ -32302,7 +32925,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *119 + '409': *122 '404': *6 x-github: githubCloudOnly: true @@ -32327,8 +32950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *114 - - *170 + - *117 + - *173 responses: '204': description: Response @@ -32353,8 +32976,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 - *17 - *18 responses: @@ -32423,7 +33046,7 @@ paths: parent: anyOf: - type: 'null' - - *211 + - *214 required: - id - node_id @@ -32437,7 +33060,7 @@ paths: - slug - parent examples: - default: *212 + default: *215 headers: Link: *37 '404': @@ -32466,8 +33089,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role parameters: - - *114 - - *170 + - *117 + - *173 - *17 - *18 responses: @@ -32599,7 +33222,7 @@ paths: - type - url examples: - default: *201 + default: *204 headers: Link: *37 '404': @@ -32623,7 +33246,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *114 + - *117 - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) @@ -32647,7 +33270,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -32672,8 +33295,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *114 - - *154 + - *117 + - *157 requestBody: required: false content: @@ -32730,8 +33353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -32788,8 +33411,8 @@ paths: - docker - nuget - container - - *114 - - &620 + - *117 + - &623 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -32825,12 +33448,12 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *214 + default: *217 '403': *27 '401': *23 - '400': &622 + '400': &625 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -32852,7 +33475,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &215 + - &218 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 @@ -32870,20 +33493,20 @@ paths: - docker - nuget - container - - &216 + - &219 name: package_name description: The name of the package. in: path required: true schema: type: string - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: default: value: @@ -32935,9 +33558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 responses: '204': description: Response @@ -32969,9 +33592,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 - name: token description: package token schema: @@ -33003,9 +33626,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-an-organization parameters: - - *215 - - *216 - - *114 + - *218 + - *219 + - *117 - *18 - *17 - name: state @@ -33025,7 +33648,7 @@ paths: application/json: schema: type: array - items: &217 + items: &220 title: Package Version description: A version of a software package type: object @@ -33160,10 +33783,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: - - *215 - - *216 - - *114 - - &218 + - *218 + - *219 + - *117 + - &221 name: package_version_id description: Unique identifier of the package version. in: path @@ -33175,7 +33798,7 @@ paths: description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -33211,10 +33834,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *215 - - *216 - - *114 - *218 + - *219 + - *117 + - *221 responses: '204': description: Response @@ -33246,10 +33869,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *215 - - *216 - - *114 - *218 + - *219 + - *117 + - *221 responses: '204': description: Response @@ -33276,10 +33899,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *114 + - *117 - *17 - *18 - - &220 + - &223 name: sort description: The property by which to sort the results. in: query @@ -33290,7 +33913,7 @@ paths: - created_at default: created_at - *65 - - &221 + - &224 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -33302,7 +33925,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &222 + - &225 name: repository description: The name of the repository to use to filter the results. in: query @@ -33311,7 +33934,7 @@ paths: type: string examples: - Hello-World - - &223 + - &226 name: permission description: The permission to use to filter the results. in: query @@ -33320,7 +33943,7 @@ paths: type: string examples: - issues_read - - &224 + - &227 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) @@ -33330,7 +33953,7 @@ paths: schema: type: string format: date-time - - &225 + - &228 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) @@ -33482,7 +34105,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens parameters: - - *114 + - *117 requestBody: required: true content: @@ -33528,7 +34151,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *120 + '202': *123 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33549,7 +34172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token parameters: - - *114 + - *117 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -33590,7 +34213,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *163 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -33611,7 +34234,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token parameters: - - *114 + - *117 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -33631,9 +34254,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -33656,16 +34279,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-fine-grained-personal-access-tokens-with-access-to-organization-resources parameters: - - *114 + - *117 - *17 - *18 - - *220 - - *65 - - *221 - - *222 - *223 + - *65 - *224 - *225 + - *226 + - *227 + - *228 responses: '500': *69 '422': *15 @@ -33802,7 +34425,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens parameters: - - *114 + - *117 requestBody: required: true content: @@ -33839,7 +34462,7 @@ paths: responses: '500': *69 '404': *6 - '202': *120 + '202': *123 '403': *27 '422': *15 x-github: @@ -33862,7 +34485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources parameters: - - *114 + - *117 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -33892,7 +34515,7 @@ paths: responses: '500': *69 '404': *6 - '204': *163 + '204': *166 '403': *27 '422': *15 x-github: @@ -33914,7 +34537,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to parameters: - - *114 + - *117 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -33933,9 +34556,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -33957,7 +34580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *114 + - *117 - name: state description: Indicates the state of the projects to return. in: query @@ -33978,7 +34601,7 @@ paths: application/json: schema: type: array - items: &226 + items: &229 title: Project description: Projects are a way to organize columns and cards of work. @@ -34131,7 +34754,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *114 + - *117 requestBody: required: true content: @@ -34157,7 +34780,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: default: value: @@ -34195,7 +34818,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &291 + '410': &294 description: Gone content: application/json: @@ -34219,7 +34842,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -34227,7 +34850,7 @@ paths: application/json: schema: type: array - items: &227 + items: &230 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -34295,7 +34918,7 @@ paths: - property_name - value_type examples: - default: &228 + default: &231 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34336,7 +34959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *114 + - *117 requestBody: required: true content: @@ -34347,7 +34970,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *227 + items: *230 minItems: 1 maxItems: 100 required: @@ -34377,9 +35000,9 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: - default: *228 + default: *231 '403': *27 '404': *6 x-github: @@ -34400,8 +35023,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *114 - - &229 + - *117 + - &232 name: custom_property_name description: The custom property name in: path @@ -34413,9 +35036,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: - default: &230 + default: &233 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -34448,8 +35071,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *114 - - *229 + - *117 + - *232 requestBody: required: true content: @@ -34514,9 +35137,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: - default: *230 + default: *233 '403': *27 '404': *6 x-github: @@ -34539,10 +35162,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *114 - - *229 + - *117 + - *232 responses: - '204': *163 + '204': *166 '403': *27 '404': *6 x-github: @@ -34563,7 +35186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *114 + - *117 - *17 - *18 - name: repository_query @@ -34604,7 +35227,7 @@ paths: - octocat/Hello-World properties: type: array - items: &231 + items: &234 title: Custom Property Value description: Custom property name and associated value type: object @@ -34674,7 +35297,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories parameters: - - *114 + - *117 requestBody: required: true content: @@ -34694,7 +35317,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *231 + items: *234 required: - repository_names - properties @@ -34735,7 +35358,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *114 + - *117 - *17 - *18 responses: @@ -34747,7 +35370,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -34766,8 +35389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response if user is a public member @@ -34791,8 +35414,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -34813,8 +35436,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *114 - - *154 + - *117 + - *157 responses: '204': description: Response @@ -34838,7 +35461,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *114 + - *117 - name: type description: Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation @@ -34885,9 +35508,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -34908,7 +35531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *114 + - *117 requestBody: required: true content: @@ -35091,7 +35714,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &296 title: Full Repository description: Full Repository type: object @@ -35537,7 +36160,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 organization: anyOf: - type: 'null' @@ -35556,7 +36179,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &403 + code_of_conduct: &406 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -35586,7 +36209,7 @@ paths: - key - name - html_url - security_and_analysis: *232 + security_and_analysis: *235 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -35670,7 +36293,7 @@ paths: - network_count - subscribers_count examples: - default: &295 + default: &298 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -36188,7 +36811,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response @@ -36196,9 +36819,9 @@ paths: application/json: schema: type: array - items: *233 + items: *236 examples: - default: *234 + default: *237 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -36220,10 +36843,10 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - *17 - *18 - - &533 + - &536 name: targets description: | A comma-separated list of rule targets to filter by. @@ -36242,7 +36865,7 @@ paths: application/json: schema: type: array - items: &241 + items: &244 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -36275,7 +36898,7 @@ paths: source: type: string description: The name of the source - enforcement: &237 + enforcement: &240 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -36287,7 +36910,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &238 + items: &241 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -36355,7 +36978,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &235 + - &238 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -36379,7 +37002,7 @@ paths: match. items: type: string - - &239 + - &242 title: Organization ruleset conditions type: object description: |- @@ -36392,7 +37015,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -36426,7 +37049,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -36448,7 +37071,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *235 + - *238 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -36461,7 +37084,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &236 + items: &239 title: Repository ruleset property targeting definition type: object @@ -36494,7 +37117,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *236 + items: *239 required: - repository_property type: @@ -36502,12 +37125,12 @@ paths: - object rules: type: array - items: &240 + items: &243 title: Repository Rule type: object description: A repository rule. oneOf: - - &515 + - &518 title: creation description: Only allow users with bypass permission to create matching refs. @@ -36519,7 +37142,7 @@ paths: type: string enum: - creation - - &516 + - &519 title: update description: Only allow users with bypass permission to update matching refs. @@ -36540,7 +37163,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &518 + - &521 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -36552,7 +37175,7 @@ paths: type: string enum: - deletion - - &519 + - &522 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -36564,7 +37187,7 @@ paths: type: string enum: - required_linear_history - - &520 + - &523 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -36642,7 +37265,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &521 + - &524 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -36666,7 +37289,7 @@ paths: type: string required: - required_deployment_environments - - &522 + - &525 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -36678,7 +37301,7 @@ paths: type: string enum: - required_signatures - - &523 + - &526 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -36724,7 +37347,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &524 + - &527 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -36772,7 +37395,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &525 + - &528 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -36784,7 +37407,7 @@ paths: type: string enum: - non_fast_forward - - &526 + - &529 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -36820,7 +37443,7 @@ paths: required: - operator - pattern - - &527 + - &530 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -36856,7 +37479,7 @@ paths: required: - operator - pattern - - &528 + - &531 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -36892,7 +37515,7 @@ paths: required: - operator - pattern - - &529 + - &532 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -36928,7 +37551,7 @@ paths: required: - operator - pattern - - &530 + - &533 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -37054,7 +37677,7 @@ paths: maximum: 100 required: - max_file_size - - &531 + - &534 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -37104,7 +37727,7 @@ paths: - repository_id required: - workflows - - &532 + - &535 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -37217,7 +37840,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 requestBody: description: Request body required: true @@ -37237,16 +37860,16 @@ paths: - tag - push default: branch - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *239 + items: *241 + conditions: *242 rules: type: array description: An array of rules within the ruleset. - items: *240 + items: *243 required: - name - enforcement @@ -37284,9 +37907,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: &242 + default: &245 value: id: 21 name: super cool ruleset @@ -37340,8 +37963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *114 - - &534 + - *117 + - &537 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 @@ -37357,7 +37980,7 @@ paths: in: query schema: type: integer - - &535 + - &538 name: time_period description: |- The time period to filter by. @@ -37373,14 +37996,14 @@ paths: - week - month default: day - - &536 + - &539 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 - - &537 + - &540 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -37400,7 +38023,7 @@ paths: description: Response content: application/json: - schema: &538 + schema: &541 title: Rule Suites description: Response type: array @@ -37456,7 +38079,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &539 + default: &542 value: - id: 21 actor_id: 12 @@ -37499,8 +38122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *114 - - &540 + - *117 + - &543 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -37516,7 +38139,7 @@ paths: description: Response content: application/json: - schema: &541 + schema: &544 title: Rule Suite description: Response type: object @@ -37623,7 +38246,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &542 + default: &545 value: id: 21 actor_id: 12 @@ -37684,7 +38307,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37696,9 +38319,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *242 + default: *245 '404': *6 '500': *69 put: @@ -37716,7 +38339,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37741,16 +38364,16 @@ paths: - branch - tag - push - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *239 + items: *241 + conditions: *242 rules: description: An array of rules within the ruleset. type: array - items: *240 + items: *243 examples: default: value: @@ -37785,9 +38408,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *242 + default: *245 '404': *6 '500': *69 delete: @@ -37805,7 +38428,7 @@ paths: category: orgs subcategory: rules parameters: - - *114 + - *117 - name: ruleset_id description: The ID of the ruleset. in: path @@ -37833,15 +38456,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *114 - - *243 - - *244 - - *245 + - *117 - *246 + - *247 + - *248 + - *249 - *65 - *18 - *17 - - &544 + - &547 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 @@ -37851,7 +38474,7 @@ paths: required: false schema: type: string - - &545 + - &548 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 @@ -37861,9 +38484,9 @@ paths: required: false schema: type: string - - *247 - - *248 - - *249 + - *250 + - *251 + - *252 responses: '200': description: Response @@ -37871,9 +38494,9 @@ paths: application/json: schema: type: array - items: *250 + items: *253 examples: - default: *251 + default: *254 headers: Link: *37 '404': *6 @@ -37899,7 +38522,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *114 + - *117 - *65 - name: sort description: The property to sort the results by. @@ -37943,7 +38566,7 @@ paths: application/json: schema: type: array - items: &551 + items: &554 description: A repository security advisory. type: object properties: @@ -38187,7 +38810,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 credits_detailed: type: - array @@ -38198,7 +38821,7 @@ paths: type: object properties: user: *4 - type: *252 + type: *255 state: type: string description: The state of the user's acceptance of the @@ -38224,7 +38847,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *198 + items: *201 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -38262,7 +38885,7 @@ paths: - private_fork additionalProperties: false examples: - default: &552 + default: &555 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -38644,7 +39267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *114 + - *117 responses: '200': description: Response @@ -38652,9 +39275,9 @@ paths: application/json: schema: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38677,8 +39300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -38703,8 +39326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -38730,15 +39353,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38762,7 +39385,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization parameters: - - *114 + - *117 - *17 - *18 responses: @@ -38770,9 +39393,9 @@ paths: description: Success content: application/json: - schema: *255 + schema: *258 examples: - default: *256 + default: *259 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -38794,15 +39417,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *257 + schema: *260 examples: - default: *258 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38824,15 +39447,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *259 + schema: *262 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -38849,7 +39472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-an-organization parameters: - - *114 + - *117 - *17 - name: page description: Page token @@ -38868,7 +39491,7 @@ paths: description: Response content: application/json: - schema: &282 + schema: &285 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -38920,7 +39543,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &283 + default: &286 value: groups: - group_id: '123' @@ -38941,6 +39564,75 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - *117 + - *213 + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - *18 + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *83 + examples: + default: *84 + '500': *69 + '403': *27 + '404': *6 + '422': *85 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -38969,8 +39661,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 - 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`). @@ -39002,9 +39694,9 @@ paths: application/json: schema: type: array - items: *83 + items: *86 examples: - default: *167 + default: *170 '500': *69 '401': *23 '403': *27 @@ -39026,7 +39718,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *114 + - *117 - *17 - *18 responses: @@ -39036,9 +39728,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 headers: Link: *37 '403': *27 @@ -39060,7 +39752,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *114 + - *117 requestBody: required: true content: @@ -39132,7 +39824,7 @@ paths: description: Response content: application/json: - schema: &261 + schema: &264 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -39206,7 +39898,7 @@ paths: parent: anyOf: - type: 'null' - - *211 + - *214 members_count: type: integer examples: @@ -39512,7 +40204,7 @@ paths: - repos_count - organization examples: - default: &262 + default: &265 value: id: 1 node_id: MDQ6VGVhbTE= @@ -39582,16 +40274,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 x-github: githubCloudOnly: false @@ -39612,8 +40304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: false content: @@ -39676,16 +40368,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '201': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 '422': *15 '403': *27 @@ -39710,8 +40402,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -39737,8 +40429,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *114 - - *210 + - *117 + - *213 - *65 - *17 - *18 @@ -39755,7 +40447,7 @@ paths: application/json: schema: type: array - items: &263 + items: &266 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -39846,7 +40538,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *86 + reactions: *89 required: - author - body @@ -39866,7 +40558,7 @@ paths: - updated_at - url examples: - default: &592 + default: &595 value: - author: login: octocat @@ -39940,8 +40632,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -39975,9 +40667,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: &264 + default: &267 value: author: login: octocat @@ -40049,9 +40741,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *114 - - *210 - - &265 + - *117 + - *213 + - &268 name: discussion_number description: The number that identifies the discussion. in: path @@ -40063,9 +40755,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40087,9 +40779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: false content: @@ -40112,9 +40804,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: &593 + default: &596 value: author: login: octocat @@ -40184,9 +40876,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 responses: '204': description: Response @@ -40212,9 +40904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 - *65 - *17 - *18 @@ -40225,7 +40917,7 @@ paths: application/json: schema: type: array - items: &266 + items: &269 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -40290,7 +40982,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *86 + reactions: *89 required: - author - body @@ -40305,7 +40997,7 @@ paths: - updated_at - url examples: - default: &594 + default: &597 value: - author: login: octocat @@ -40373,9 +41065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: true content: @@ -40397,9 +41089,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: &267 + default: &270 value: author: login: octocat @@ -40465,10 +41157,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *114 - - *210 - - *265 - - &268 + - *117 + - *213 + - *268 + - &271 name: comment_number description: The number that identifies the comment. in: path @@ -40480,9 +41172,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40504,10 +41196,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 requestBody: required: true content: @@ -40529,9 +41221,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: &595 + default: &598 value: author: login: octocat @@ -40595,10 +41287,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 responses: '204': description: Response @@ -40624,10 +41316,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 - 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. @@ -40653,7 +41345,7 @@ paths: application/json: schema: type: array - items: &269 + items: &272 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -40697,7 +41389,7 @@ paths: - content - created_at examples: - default: &271 + default: &274 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40747,10 +41439,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 + - *271 requestBody: required: true content: @@ -40783,9 +41475,9 @@ paths: team discussion comment content: application/json: - schema: *269 + schema: *272 examples: - default: &270 + default: &273 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -40814,9 +41506,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40839,11 +41531,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *114 - - *210 - - *265 + - *117 + - *213 - *268 - - &272 + - *271 + - &275 name: reaction_id description: The unique identifier of the reaction. in: path @@ -40875,9 +41567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 - 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. @@ -40903,9 +41595,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -40931,9 +41623,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *114 - - *210 - - *265 + - *117 + - *213 + - *268 requestBody: required: true content: @@ -40965,16 +41657,16 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40997,10 +41689,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *114 - - *210 - - *265 - - *272 + - *117 + - *213 + - *268 + - *275 responses: '204': description: Response @@ -41023,16 +41715,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -41051,8 +41743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -41076,9 +41768,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -41097,8 +41789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '204': description: Response @@ -41122,8 +41814,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41133,9 +41825,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 x-github: @@ -41157,8 +41849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *114 - - *210 + - *117 + - *213 - name: role description: Filters members returned by their role in the team. in: query @@ -41181,7 +41873,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -41211,15 +41903,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 responses: '200': description: Response content: application/json: - schema: &277 + schema: &280 title: Team Membership description: Team Membership type: object @@ -41247,7 +41939,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &596 + response-if-user-is-a-team-maintainer: &599 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -41283,9 +41975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 requestBody: required: false content: @@ -41310,9 +42002,9 @@ paths: description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-users-membership-with-team-is-now-pending: &597 + response-if-users-membership-with-team-is-now-pending: &600 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -41347,9 +42039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *114 - - *210 - - *154 + - *117 + - *213 + - *157 responses: '204': description: Response @@ -41375,8 +42067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41386,7 +42078,7 @@ paths: application/json: schema: type: array - items: &278 + items: &281 title: Team Project description: A team's access to a project. type: object @@ -41455,7 +42147,7 @@ paths: - updated_at - permissions examples: - default: &598 + default: &601 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41516,9 +42208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *114 - - *210 - - &279 + - *117 + - *213 + - &282 name: project_id description: The unique identifier of the project. in: path @@ -41530,9 +42222,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &599 + default: &602 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -41592,9 +42284,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *114 - - *210 - - *279 + - *117 + - *213 + - *282 requestBody: required: false content: @@ -41659,9 +42351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *114 - - *210 - - *279 + - *117 + - *213 + - *282 responses: '204': description: Response @@ -41685,8 +42377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -41696,9 +42388,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -41727,16 +42419,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &600 + schema: &603 title: Team Repository description: A team's access to a repository. type: object @@ -41762,7 +42454,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 forks: type: integer permissions: @@ -42377,10 +43069,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 requestBody: required: false content: @@ -42425,10 +43117,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *114 - - *210 - - *280 - - *281 + - *117 + - *213 + - *283 + - *284 responses: '204': description: Response @@ -42454,16 +43146,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team parameters: - - *114 - - *210 + - *117 + - *213 responses: '200': description: Response content: application/json: - schema: *282 + schema: *285 examples: - default: *283 + default: *286 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -42485,8 +43177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections parameters: - - *114 - - *210 + - *117 + - *213 requestBody: required: true content: @@ -42529,7 +43221,7 @@ paths: description: Response content: application/json: - schema: *282 + schema: *285 examples: default: value: @@ -42561,8 +43253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *114 - - *210 + - *117 + - *213 - *17 - *18 responses: @@ -42572,9 +43264,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - response-if-child-teams-exist: &601 + response-if-child-teams-exist: &604 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -42627,7 +43319,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *114 + - *117 - name: security_product in: path description: The security feature to enable or disable. @@ -42698,7 +43390,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &284 + - &287 name: card_id description: The unique identifier of the card. in: path @@ -42710,7 +43402,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &288 title: Project Card description: Project cards represent a scope of work. type: object @@ -42785,7 +43477,7 @@ paths: - created_at - updated_at examples: - default: &286 + default: &289 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -42835,7 +43527,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *284 + - *287 requestBody: required: false content: @@ -42865,9 +43557,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 '304': *35 '403': *27 '401': *23 @@ -42888,7 +43580,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *284 + - *287 responses: '204': description: Response @@ -42926,7 +43618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *284 + - *287 requestBody: required: true content: @@ -43033,7 +43725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &287 + - &290 name: column_id description: The unique identifier of the column. in: path @@ -43045,7 +43737,7 @@ paths: description: Response content: application/json: - schema: &288 + schema: &291 title: Project Column description: Project columns contain cards of work. type: object @@ -43099,7 +43791,7 @@ paths: - created_at - updated_at examples: - default: &289 + default: &292 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -43128,7 +43820,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *287 + - *290 requestBody: required: true content: @@ -43153,9 +43845,9 @@ paths: description: Response content: application/json: - schema: *288 + schema: *291 examples: - default: *289 + default: *292 '304': *35 '403': *27 '401': *23 @@ -43174,7 +43866,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *287 + - *290 responses: '204': description: Response @@ -43197,7 +43889,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *287 + - *290 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -43218,7 +43910,7 @@ paths: application/json: schema: type: array - items: *285 + items: *288 examples: default: value: @@ -43271,7 +43963,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *287 + - *290 requestBody: required: true content: @@ -43315,9 +44007,9 @@ paths: description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 '304': *35 '403': *27 '401': *23 @@ -43327,8 +44019,8 @@ paths: application/json: schema: oneOf: - - *117 - - *118 + - *120 + - *121 '503': description: Response content: @@ -43367,7 +44059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *287 + - *290 requestBody: required: true content: @@ -43424,15 +44116,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *279 + - *282 responses: '200': description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &290 + default: &293 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -43485,7 +44177,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *279 + - *282 requestBody: required: false content: @@ -43534,9 +44226,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *290 + default: *293 '404': description: Not Found if the authenticated user does not have access to the project @@ -43557,7 +44249,7 @@ paths: items: type: string '401': *23 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -43575,7 +44267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *279 + - *282 responses: '204': description: Delete Success @@ -43596,7 +44288,7 @@ paths: items: type: string '401': *23 - '410': *291 + '410': *294 '404': *6 x-github: githubCloudOnly: false @@ -43619,7 +44311,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *279 + - *282 - 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 @@ -43646,7 +44338,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -43671,8 +44363,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *279 - - *154 + - *282 + - *157 requestBody: required: false content: @@ -43721,8 +44413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *279 - - *154 + - *282 + - *157 responses: '204': description: Response @@ -43750,8 +44442,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *279 - - *154 + - *282 + - *157 responses: '200': description: Response @@ -43815,7 +44507,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *279 + - *282 - *17 - *18 responses: @@ -43825,7 +44517,7 @@ paths: application/json: schema: type: array - items: *288 + items: *291 examples: default: value: @@ -43857,7 +44549,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *279 + - *282 requestBody: required: true content: @@ -43881,7 +44573,7 @@ paths: description: Response content: application/json: - schema: *288 + schema: *291 examples: default: value: @@ -43942,7 +44634,7 @@ paths: resources: type: object properties: - core: &292 + core: &295 title: Rate Limit type: object properties: @@ -43959,19 +44651,19 @@ paths: - remaining - reset - used - graphql: *292 - search: *292 - code_search: *292 - source_import: *292 - integration_manifest: *292 - code_scanning_upload: *292 - actions_runner_registration: *292 - scim: *292 - dependency_snapshots: *292 + graphql: *295 + search: *295 + code_search: *295 + source_import: *295 + integration_manifest: *295 + code_scanning_upload: *295 + actions_runner_registration: *295 + scim: *295 + dependency_snapshots: *295 required: - core - search - rate: *292 + rate: *295 required: - rate - resources @@ -44070,14 +44762,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *293 + schema: *296 examples: default-response: summary: Default response @@ -44582,7 +45274,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *294 + '301': *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44600,8 +45292,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -44848,10 +45540,10 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 - '307': &296 + default: *298 + '307': &299 description: Temporary Redirect content: application/json: @@ -44880,8 +45572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -44903,7 +45595,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': *296 + '307': *299 '404': *6 x-github: githubCloudOnly: false @@ -44926,11 +45618,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - - &311 + - &314 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -44953,7 +45645,7 @@ paths: type: integer artifacts: type: array - items: &297 + items: &300 title: Artifact description: An artifact type: object @@ -45039,7 +45731,7 @@ paths: - expires_at - updated_at examples: - default: &312 + default: &315 value: total_count: 2 artifacts: @@ -45098,9 +45790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *280 - - *281 - - &298 + - *283 + - *284 + - &301 name: artifact_id description: The unique identifier of the artifact. in: path @@ -45112,7 +45804,7 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: default: value: @@ -45149,9 +45841,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *280 - - *281 - - *298 + - *283 + - *284 + - *301 responses: '204': description: Response @@ -45175,9 +45867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *280 - - *281 - - *298 + - *283 + - *284 + - *301 - name: archive_format in: path required: true @@ -45191,7 +45883,7 @@ paths: example: https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D schema: type: string - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45214,14 +45906,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *299 + schema: *302 examples: default: value: @@ -45247,11 +45939,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: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - - &300 + - &303 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 @@ -45285,7 +45977,7 @@ paths: description: Response content: application/json: - schema: &301 + schema: &304 title: Repository actions caches description: Repository actions caches type: object @@ -45335,7 +46027,7 @@ paths: - total_count - actions_caches examples: - default: &302 + default: &305 value: total_count: 1 actions_caches: @@ -45367,23 +46059,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: - - *280 - - *281 + - *283 + - *284 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *300 + - *303 responses: '200': description: Response content: application/json: - schema: *301 + schema: *304 examples: - default: *302 + default: *305 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45403,8 +46095,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: - - *280 - - *281 + - *283 + - *284 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -45435,9 +46127,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: - - *280 - - *281 - - &303 + - *283 + - *284 + - &306 name: job_id description: The unique identifier of the job. in: path @@ -45449,7 +46141,7 @@ paths: description: Response content: application/json: - schema: &315 + schema: &318 title: Job description: Information of a job execution in a workflow run type: object @@ -45796,9 +46488,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: - - *280 - - *281 - - *303 + - *283 + - *284 + - *306 responses: '302': description: Response @@ -45826,9 +46518,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: - - *280 - - *281 - - *303 + - *283 + - *284 + - *306 requestBody: required: false content: @@ -45850,7 +46542,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -45874,8 +46566,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Status response @@ -45925,8 +46617,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -45960,7 +46652,7 @@ paths: description: Empty response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -45989,8 +46681,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -46008,7 +46700,7 @@ paths: type: integer secrets: type: array - items: &317 + items: &320 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -46029,7 +46721,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &321 value: total_count: 2 secrets: @@ -46062,9 +46754,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *280 - - *281 - - *304 + - *283 + - *284 + - *307 - *18 responses: '200': @@ -46081,7 +46773,7 @@ paths: type: integer variables: type: array - items: &321 + items: &324 title: Actions Variable type: object properties: @@ -46115,7 +46807,7 @@ paths: - created_at - updated_at examples: - default: &322 + default: &325 value: total_count: 2 variables: @@ -46148,8 +46840,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46158,11 +46850,11 @@ paths: schema: type: object properties: - enabled: &305 + enabled: &308 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *40 - selected_actions_url: *125 + selected_actions_url: *128 required: - enabled examples: @@ -46191,8 +46883,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -46203,7 +46895,7 @@ paths: schema: type: object properties: - enabled: *305 + enabled: *308 allowed_actions: *40 required: - enabled @@ -46234,14 +46926,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &306 + schema: &309 type: object properties: access_level: @@ -46259,7 +46951,7 @@ paths: required: - access_level examples: - default: &307 + default: &310 value: access_level: organization x-github: @@ -46284,15 +46976,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: application/json: - schema: *306 + schema: *309 examples: - default: *307 + default: *310 responses: '204': description: Response @@ -46316,8 +47008,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46348,8 +47040,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -46381,14 +47073,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: default: *46 x-github: @@ -46411,8 +47103,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Success response @@ -46423,7 +47115,7 @@ paths: required: true content: application/json: - schema: *129 + schema: *132 examples: default: *46 x-github: @@ -46452,8 +47144,8 @@ paths: in: query schema: type: string - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -46497,8 +47189,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -46506,9 +47198,9 @@ paths: application/json: schema: type: array - items: *133 + items: *136 examples: - default: *134 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46530,8 +47222,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -46574,7 +47266,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *135 + '201': *138 '404': *6 '422': *7 x-github: @@ -46604,8 +47296,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: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -46613,7 +47305,7 @@ paths: application/json: schema: *56 examples: - default: *136 + default: *139 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46641,8 +47333,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: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -46650,7 +47342,7 @@ paths: application/json: schema: *56 examples: - default: *137 + default: *140 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46672,8 +47364,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '200': @@ -46682,7 +47374,7 @@ paths: application/json: schema: *53 examples: - default: *138 + default: *141 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46703,8 +47395,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '204': @@ -46730,8 +47422,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: '200': *58 @@ -46756,8 +47448,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: - - *280 - - *281 + - *283 + - *284 - *52 requestBody: required: true @@ -46806,8 +47498,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: - - *280 - - *281 + - *283 + - *284 - *52 requestBody: required: true @@ -46857,11 +47549,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: - - *280 - - *281 + - *283 + - *284 - *52 responses: - '200': *139 + '200': *142 '404': *6 x-github: githubCloudOnly: false @@ -46888,10 +47580,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: - - *280 - - *281 + - *283 + - *284 - *52 - - *140 + - *143 responses: '200': *58 '404': *6 @@ -46919,9 +47611,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: - - *280 - - *281 - - &325 + - *283 + - *284 + - &328 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. @@ -46929,7 +47621,7 @@ paths: required: false schema: type: string - - &326 + - &329 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -46937,7 +47629,7 @@ paths: required: false schema: type: string - - &327 + - &330 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -46946,7 +47638,7 @@ paths: required: false schema: type: string - - &328 + - &331 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 @@ -46973,7 +47665,7 @@ paths: - pending - *17 - *18 - - &329 + - &332 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)." @@ -46982,7 +47674,7 @@ paths: schema: type: string format: date-time - - &308 + - &311 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -46991,13 +47683,13 @@ paths: schema: type: boolean default: false - - &330 + - &333 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &331 + - &334 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -47020,7 +47712,7 @@ paths: type: integer workflow_runs: type: array - items: &309 + items: &312 title: Workflow Run description: An invocation of a workflow type: object @@ -47137,7 +47829,7 @@ paths: type: - array - 'null' - items: &350 + items: &353 title: Pull Request Minimal type: object properties: @@ -47264,7 +47956,7 @@ paths: head_commit: anyOf: - type: 'null' - - &354 + - &357 title: Simple Commit description: A commit. type: object @@ -47338,8 +48030,8 @@ paths: - timestamp - author - committer - repository: *132 - head_repository: *132 + repository: *135 + head_repository: *135 head_repository_id: type: integer examples: @@ -47379,7 +48071,7 @@ paths: - workflow_url - pull_requests examples: - default: &332 + default: &335 value: total_count: 1 workflow_runs: @@ -47615,24 +48307,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *280 - - *281 - - &310 + - *283 + - *284 + - &313 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *308 + - *311 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &313 + default: &316 value: id: 30433642 name: Build @@ -47873,9 +48565,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '204': description: Response @@ -47898,9 +48590,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -48028,15 +48720,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -48063,12 +48755,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 - *17 - *18 - - *311 + - *314 responses: '200': description: Response @@ -48084,9 +48776,9 @@ paths: type: integer artifacts: type: array - items: *297 + items: *300 examples: - default: *312 + default: *315 headers: Link: *37 x-github: @@ -48110,25 +48802,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *280 - - *281 - - *310 - - &314 + - *283 + - *284 + - *313 + - &317 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *308 + - *311 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *313 + default: *316 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48151,10 +48843,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: - - *280 - - *281 - - *310 - - *314 + - *283 + - *284 + - *313 + - *317 - *17 - *18 responses: @@ -48172,9 +48864,9 @@ paths: type: integer jobs: type: array - items: *315 + items: *318 examples: - default: &316 + default: &319 value: total_count: 1 jobs: @@ -48287,10 +48979,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *280 - - *281 - - *310 - - *314 + - *283 + - *284 + - *313 + - *317 responses: '302': description: Response @@ -48318,19 +49010,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '202': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48353,9 +49045,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: true content: @@ -48422,19 +49114,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '202': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48457,9 +49149,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 - 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 @@ -48489,9 +49181,9 @@ paths: type: integer jobs: type: array - items: *315 + items: *318 examples: - default: *316 + default: *319 headers: Link: *37 x-github: @@ -48516,9 +49208,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '302': description: Response @@ -48545,9 +49237,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '204': description: Response @@ -48574,9 +49266,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -48645,7 +49337,7 @@ paths: items: type: object properties: - type: &422 + type: &425 type: string description: The type of reviewer. enum: @@ -48656,7 +49348,7 @@ paths: reviewer: anyOf: - *4 - - *198 + - *201 required: - environment - wait_timer @@ -48731,9 +49423,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: true content: @@ -48783,7 +49475,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -48895,7 +49587,7 @@ paths: - created_at - updated_at examples: - default: &418 + default: &421 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -48951,9 +49643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: false content: @@ -48975,7 +49667,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -48998,9 +49690,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: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 requestBody: required: false content: @@ -49022,7 +49714,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49047,9 +49739,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *280 - - *281 - - *310 + - *283 + - *284 + - *313 responses: '200': description: Response @@ -49186,8 +49878,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -49205,9 +49897,9 @@ paths: type: integer secrets: type: array - items: *317 + items: *320 examples: - default: *318 + default: *321 headers: Link: *37 x-github: @@ -49232,16 +49924,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *320 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49263,17 +49955,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *317 + schema: *320 examples: - default: &435 + default: &438 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -49299,9 +49991,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -49329,7 +50021,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49355,9 +50047,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -49382,9 +50074,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *280 - - *281 - - *304 + - *283 + - *284 + - *307 - *18 responses: '200': @@ -49401,9 +50093,9 @@ paths: type: integer variables: type: array - items: *321 + items: *324 examples: - default: *322 + default: *325 headers: Link: *37 x-github: @@ -49426,8 +50118,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -49454,7 +50146,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -49479,17 +50171,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: &436 + default: &439 value: name: USERNAME value: octocat @@ -49515,9 +50207,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 requestBody: required: true content: @@ -49559,9 +50251,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *280 - - *281 - - *145 + - *283 + - *284 + - *148 responses: '204': description: Response @@ -49586,8 +50278,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -49605,7 +50297,7 @@ paths: type: integer workflows: type: array - items: &323 + items: &326 title: Workflow description: A GitHub Actions workflow type: object @@ -49723,9 +50415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *280 - - *281 - - &324 + - *283 + - *284 + - &327 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -49740,7 +50432,7 @@ paths: description: Response content: application/json: - schema: *323 + schema: *326 examples: default: value: @@ -49773,9 +50465,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49800,9 +50492,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49853,9 +50545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '204': description: Response @@ -49880,19 +50572,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: - - *280 - - *281 - - *324 - - *325 - - *326 + - *283 + - *284 - *327 - *328 - - *17 - - *18 - *329 - - *308 - *330 - *331 + - *17 + - *18 + - *332 + - *311 + - *333 + - *334 responses: '200': description: Response @@ -49908,9 +50600,9 @@ paths: type: integer workflow_runs: type: array - items: *309 + items: *312 examples: - default: *332 + default: *335 headers: Link: *37 x-github: @@ -49936,9 +50628,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *280 - - *281 - - *324 + - *283 + - *284 + - *327 responses: '200': description: Response @@ -49999,8 +50691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *280 - - *281 + - *283 + - *284 - *65 - *17 - *63 @@ -50168,8 +50860,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -50181,7 +50873,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -50206,8 +50898,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: - - *280 - - *281 + - *283 + - *284 - name: assignee in: path required: true @@ -50243,8 +50935,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -50356,8 +51048,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *63 - *64 @@ -50401,7 +51093,7 @@ paths: repository_id: type: integer examples: - default: *333 + default: *336 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50421,8 +51113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -50430,7 +51122,7 @@ paths: application/json: schema: type: array - items: &334 + items: &337 title: Autolink reference description: An autolink reference. type: object @@ -50484,8 +51176,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -50524,9 +51216,9 @@ paths: description: response content: application/json: - schema: *334 + schema: *337 examples: - default: &335 + default: &338 value: id: 1 key_prefix: TICKET- @@ -50557,9 +51249,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: - - *280 - - *281 - - &336 + - *283 + - *284 + - &339 name: autolink_id description: The unique identifier of the autolink. in: path @@ -50571,9 +51263,9 @@ paths: description: Response content: application/json: - schema: *334 + schema: *337 examples: - default: *335 + default: *338 '404': *6 x-github: githubCloudOnly: false @@ -50593,9 +51285,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: - - *280 - - *281 - - *336 + - *283 + - *284 + - *339 responses: '204': description: Response @@ -50619,8 +51311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response if Dependabot is enabled @@ -50670,8 +51362,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -50692,8 +51384,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -50713,8 +51405,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *280 - - *281 + - *283 + - *284 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -50752,7 +51444,7 @@ paths: - url protected: type: boolean - protection: &338 + protection: &341 title: Branch Protection description: Branch Protection type: object @@ -50795,7 +51487,7 @@ paths: required: - contexts - checks - enforce_admins: &341 + enforce_admins: &344 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -50812,7 +51504,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &343 + required_pull_request_reviews: &346 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -50834,7 +51526,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *198 + items: *201 apps: description: The list of apps with review dismissal access. @@ -50866,7 +51558,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *198 + items: *201 apps: description: The list of apps allowed to bypass pull request requirements. @@ -50896,7 +51588,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &340 + restrictions: &343 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -51221,9 +51913,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *280 - - *281 - - &339 + - *283 + - *284 + - &342 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). @@ -51237,14 +51929,14 @@ paths: description: Response content: application/json: - schema: &349 + schema: &352 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &393 + commit: &396 title: Commit description: Commit type: object @@ -51283,7 +51975,7 @@ paths: author: anyOf: - type: 'null' - - &337 + - &340 title: Git User description: Metaproperties for Git author/committer information. @@ -51304,7 +51996,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 message: type: string examples: @@ -51328,7 +52020,7 @@ paths: required: - sha - url - verification: &442 + verification: &445 title: Verification type: object properties: @@ -51359,14 +52051,14 @@ paths: author: oneOf: - *4 - - *143 + - *146 type: - 'null' - object committer: oneOf: - *4 - - *143 + - *146 type: - 'null' - object @@ -51403,7 +52095,7 @@ paths: type: integer files: type: array - items: &405 + items: &408 title: Diff Entry description: Diff Entry type: object @@ -51497,7 +52189,7 @@ paths: - self protected: type: boolean - protection: *338 + protection: *341 protection_url: type: string format: uri @@ -51605,7 +52297,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *294 + '301': *297 '404': *6 x-github: githubCloudOnly: false @@ -51627,15 +52319,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *338 + schema: *341 examples: default: value: @@ -51829,9 +52521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -52091,7 +52783,7 @@ paths: url: type: string format: uri - required_status_checks: &346 + required_status_checks: &349 title: Status Check Policy description: Status Check Policy type: object @@ -52172,7 +52864,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 apps: type: array items: *5 @@ -52190,7 +52882,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 apps: type: array items: *5 @@ -52250,7 +52942,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *340 + restrictions: *343 required_conversation_resolution: type: object properties: @@ -52362,9 +53054,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52389,17 +53081,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: &342 + default: &345 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -52421,17 +53113,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: *342 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52450,9 +53142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52477,17 +53169,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *343 + schema: *346 examples: - default: &344 + default: &347 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -52583,9 +53275,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -52683,9 +53375,9 @@ paths: description: Response content: application/json: - schema: *343 + schema: *346 examples: - default: *344 + default: *347 '422': *15 x-github: githubCloudOnly: false @@ -52706,9 +53398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52735,17 +53427,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: &345 + default: &348 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -52768,17 +53460,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *341 + schema: *344 examples: - default: *345 + default: *348 '404': *6 x-github: githubCloudOnly: false @@ -52798,9 +53490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52825,17 +53517,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: &347 + default: &350 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -52861,9 +53553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -52915,9 +53607,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 '404': *6 '422': *15 x-github: @@ -52939,9 +53631,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -52965,9 +53657,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53001,9 +53693,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53070,9 +53762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53136,9 +53828,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: content: application/json: @@ -53204,15 +53896,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response content: application/json: - schema: *340 + schema: *343 examples: default: value: @@ -53303,9 +53995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '204': description: Response @@ -53328,9 +54020,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53340,7 +54032,7 @@ paths: type: array items: *5 examples: - default: &348 + default: &351 value: - id: 1 slug: octoapp @@ -53397,9 +54089,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53433,7 +54125,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53454,9 +54146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53490,7 +54182,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53511,9 +54203,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53547,7 +54239,7 @@ paths: type: array items: *5 examples: - default: *348 + default: *351 '422': *15 x-github: githubCloudOnly: false @@ -53569,9 +54261,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53579,9 +54271,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '404': *6 x-github: githubCloudOnly: false @@ -53601,9 +54293,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53639,9 +54331,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53662,9 +54354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: false content: @@ -53700,9 +54392,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53723,9 +54415,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: content: application/json: @@ -53760,9 +54452,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 '422': *15 x-github: githubCloudOnly: false @@ -53784,9 +54476,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: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 responses: '200': description: Response @@ -53796,7 +54488,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '404': *6 x-github: githubCloudOnly: false @@ -53820,9 +54512,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53855,7 +54547,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53880,9 +54572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53915,7 +54607,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -53940,9 +54632,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -53975,7 +54667,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '422': *15 x-github: githubCloudOnly: false @@ -54002,9 +54694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 requestBody: required: true content: @@ -54026,7 +54718,7 @@ paths: description: Response content: application/json: - schema: *349 + schema: *352 examples: default: value: @@ -54141,8 +54833,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -54421,7 +55113,7 @@ paths: description: Response content: application/json: - schema: &351 + schema: &354 title: CheckRun description: A check performed on the code of a given code change type: object @@ -54556,8 +55248,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *350 - deployment: &651 + items: *353 + deployment: &654 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -54844,9 +55536,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *280 - - *281 - - &352 + - *283 + - *284 + - &355 name: check_run_id description: The unique identifier of the check run. in: path @@ -54858,9 +55550,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: &353 + default: &356 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -54960,9 +55652,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 requestBody: required: true content: @@ -55202,9 +55894,9 @@ paths: description: Response content: application/json: - schema: *351 + schema: *354 examples: - default: *353 + default: *356 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55224,9 +55916,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 - *17 - *18 responses: @@ -55338,15 +56030,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *280 - - *281 - - *352 + - *283 + - *284 + - *355 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -55384,8 +56076,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -55407,7 +56099,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &355 + schema: &358 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -55488,12 +56180,12 @@ paths: type: - array - 'null' - items: *350 + items: *353 app: anyOf: - type: 'null' - *5 - repository: *132 + repository: *135 created_at: type: - string @@ -55504,7 +56196,7 @@ paths: - string - 'null' format: date-time - head_commit: *354 + head_commit: *357 latest_check_runs_count: type: integer check_runs_url: @@ -55532,7 +56224,7 @@ paths: - check_runs_url - pull_requests examples: - default: &356 + default: &359 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -55823,9 +56515,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55844,8 +56536,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -55906,7 +56598,7 @@ paths: required: - app_id - setting - repository: *132 + repository: *135 examples: default: value: @@ -56154,9 +56846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *280 - - *281 - - &357 + - *283 + - *284 + - &360 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -56168,9 +56860,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56193,17 +56885,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: - - *280 - - *281 - - *357 - - &400 + - *283 + - *284 + - *360 + - &403 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &401 + - &404 name: status description: Returns check runs with the specified `status`. in: query @@ -56242,9 +56934,9 @@ paths: type: integer check_runs: type: array - items: *351 + items: *354 examples: - default: &402 + default: &405 value: total_count: 1 check_runs: @@ -56346,15 +57038,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *280 - - *281 - - *357 + - *283 + - *284 + - *360 responses: '201': description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -56381,21 +57073,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: - - *280 - - *281 - - *155 - - *156 + - *283 + - *284 + - *158 + - *159 - *18 - *17 - - &369 + - &372 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: *358 - - &370 + schema: *361 + - &373 name: pr description: The number of the pull request for the results you want to list. in: query @@ -56420,13 +57112,13 @@ paths: be returned. in: query required: false - schema: *157 + schema: *160 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *359 + schema: *362 responses: '200': description: Response @@ -56442,7 +57134,7 @@ paths: updated_at: *77 url: *74 html_url: *75 - instances_url: *360 + instances_url: *363 state: *68 fixed_at: *79 dismissed_by: @@ -56450,11 +57142,11 @@ paths: - type: 'null' - *4 dismissed_at: *78 - dismissed_reason: *361 - dismissed_comment: *362 - rule: *363 - tool: *364 - most_recent_instance: *365 + dismissed_reason: *364 + dismissed_comment: *365 + rule: *366 + tool: *367 + most_recent_instance: *368 required: - number - created_at @@ -56570,7 +57262,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &366 + '403': &369 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -56597,9 +57289,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: - - *280 - - *281 - - &367 + - *283 + - *284 + - &370 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -56613,7 +57305,7 @@ paths: description: Response content: application/json: - schema: &368 + schema: &371 type: object properties: number: *70 @@ -56621,7 +57313,7 @@ paths: updated_at: *77 url: *74 html_url: *75 - instances_url: *360 + instances_url: *363 state: *68 fixed_at: *79 dismissed_by: @@ -56629,8 +57321,8 @@ paths: - type: 'null' - *4 dismissed_at: *78 - dismissed_reason: *361 - dismissed_comment: *362 + dismissed_reason: *364 + dismissed_comment: *365 rule: type: object properties: @@ -56692,8 +57384,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *364 - most_recent_instance: *365 + tool: *367 + most_recent_instance: *368 required: - number - created_at @@ -56782,7 +57474,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -56802,9 +57494,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 requestBody: required: true content: @@ -56819,8 +57511,8 @@ paths: enum: - open - dismissed - dismissed_reason: *361 - dismissed_comment: *362 + dismissed_reason: *364 + dismissed_comment: *365 required: - state examples: @@ -56835,7 +57527,7 @@ paths: description: Response content: application/json: - schema: *368 + schema: *371 examples: default: value: @@ -56910,7 +57602,7 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &375 + '403': &378 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -56937,13 +57629,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 - *18 - *17 - - *369 - - *370 + - *372 + - *373 responses: '200': description: Response @@ -56951,7 +57643,7 @@ paths: application/json: schema: type: array - items: *365 + items: *368 examples: default: value: @@ -56990,7 +57682,7 @@ paths: end_column: 50 classifications: - source - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57024,25 +57716,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: - - *280 - - *281 - - *155 - - *156 + - *283 + - *284 + - *158 + - *159 - *18 - *17 - - *370 + - *373 - 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: *358 + schema: *361 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &373 + schema: &376 type: string description: An identifier for the upload. examples: @@ -57064,23 +57756,23 @@ paths: application/json: schema: type: array - items: &374 + items: &377 type: object properties: - ref: *358 - commit_sha: &383 + ref: *361 + commit_sha: &386 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: *371 + analysis_key: *374 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *372 + category: *375 error: type: string examples: @@ -57105,8 +57797,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *373 - tool: *364 + sarif_id: *376 + tool: *367 deletable: type: boolean warning: @@ -57168,7 +57860,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57204,8 +57896,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: - - *280 - - *281 + - *283 + - *284 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57218,7 +57910,7 @@ paths: description: Response content: application/json: - schema: *374 + schema: *377 examples: response: summary: application/json response @@ -57272,7 +57964,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57354,8 +58046,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: - - *280 - - *281 + - *283 + - *284 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -57411,7 +58103,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': *375 + '403': *378 '404': *6 '503': *81 x-github: @@ -57433,8 +58125,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -57442,7 +58134,7 @@ paths: application/json: schema: type: array - items: &376 + items: &379 title: CodeQL Database description: A CodeQL database. type: object @@ -57554,7 +58246,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': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57583,8 +58275,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: - - *280 - - *281 + - *283 + - *284 - name: language in: path description: The language of the CodeQL database. @@ -57596,7 +58288,7 @@ paths: description: Response content: application/json: - schema: *376 + schema: *379 examples: default: value: @@ -57628,9 +58320,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': &407 + '302': &410 description: Found - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -57658,8 +58350,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -57668,7 +58360,7 @@ paths: type: object additionalProperties: false properties: - language: &377 + language: &380 type: string description: The language targeted by the CodeQL query enum: @@ -57746,7 +58438,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &381 + schema: &384 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -57756,7 +58448,7 @@ paths: description: The ID of the variant analysis. controller_repo: *80 actor: *4 - query_language: *377 + query_language: *380 query_pack_url: type: string description: The download url for the query pack. @@ -57804,7 +58496,7 @@ paths: items: type: object properties: - repository: &378 + repository: &381 title: Repository Identifier description: Repository Identifier type: object @@ -57846,7 +58538,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &382 + analysis_status: &385 type: string description: The new status of the CodeQL variant analysis repository task. @@ -57878,7 +58570,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &379 + access_mismatch_repos: &382 type: object properties: repository_count: @@ -57893,7 +58585,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: *378 + items: *381 required: - repository_count - repositories @@ -57916,8 +58608,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *379 - over_limit_repos: *379 + no_codeql_db_repos: *382 + over_limit_repos: *382 required: - access_mismatch_repos - not_found_repos @@ -57933,7 +58625,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &380 + value: &383 summary: Default response value: id: 1 @@ -58085,10 +58777,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *380 + value: *383 repository_lists: summary: Response for a successful variant analysis submission - value: *380 + value: *383 '404': *6 '422': description: Unable to process variant analysis submission @@ -58116,8 +58808,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: - - *280 - - *281 + - *283 + - *284 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -58129,9 +58821,9 @@ paths: description: Response content: application/json: - schema: *381 + schema: *384 examples: - default: *380 + default: *383 '404': *6 '503': *81 x-github: @@ -58154,7 +58846,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: - - *280 + - *283 - name: repo in: path description: The name of the controller repository. @@ -58189,7 +58881,7 @@ paths: type: object properties: repository: *80 - analysis_status: *382 + analysis_status: *385 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -58314,8 +59006,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58380,7 +59072,7 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *366 + '403': *369 '404': *6 '503': *81 x-github: @@ -58401,8 +59093,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -58447,7 +59139,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -58472,7 +59164,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *375 + '403': *378 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -58537,8 +59229,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -58546,7 +59238,7 @@ paths: schema: type: object properties: - commit_sha: *383 + commit_sha: *386 ref: type: string description: |- @@ -58606,7 +59298,7 @@ paths: schema: type: object properties: - id: *373 + id: *376 url: type: string description: The REST API URL for checking the status of the upload. @@ -58620,7 +59312,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': *375 + '403': *378 '404': *6 '413': description: Payload Too Large if the sarif field is too large @@ -58643,8 +59335,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: - - *280 - - *281 + - *283 + - *284 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -58692,7 +59384,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': *366 + '403': *369 '404': description: Not Found if the sarif id does not match any upload '503': *81 @@ -58717,8 +59409,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58742,7 +59434,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *160 + configuration: *163 examples: default: value: @@ -58771,7 +59463,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': *163 + '204': *166 '304': *35 '403': *27 '404': *6 @@ -58796,8 +59488,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *280 - - *281 + - *283 + - *284 - 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 @@ -58925,8 +59617,8 @@ paths: parameters: - *17 - *18 - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -58942,7 +59634,7 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: default: value: @@ -59240,8 +59932,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -59305,17 +59997,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '400': *14 '401': *23 '403': *27 @@ -59344,8 +60036,8 @@ paths: parameters: - *17 - *18 - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -59409,8 +60101,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: - - *280 - - *281 + - *283 + - *284 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -59447,9 +60139,9 @@ paths: type: integer machines: type: array - items: *385 + items: *388 examples: - default: &608 + default: &611 value: total_count: 2 machines: @@ -59489,8 +60181,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *280 - - *281 + - *283 + - *284 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -59577,8 +60269,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: - - *280 - - *281 + - *283 + - *284 - 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 @@ -59647,8 +60339,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -59666,7 +60358,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &392 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -59687,7 +60379,7 @@ paths: - created_at - updated_at examples: - default: *386 + default: *389 headers: Link: *37 x-github: @@ -59710,16 +60402,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *387 + schema: *390 examples: - default: *388 + default: *391 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -59739,17 +60431,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *389 + schema: *392 examples: - default: *390 + default: *393 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59769,9 +60461,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: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -59799,7 +60491,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -59823,9 +60515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -59853,8 +60545,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *280 - - *281 + - *283 + - *284 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -59892,7 +60584,7 @@ paths: application/json: schema: type: array - items: &391 + items: &394 title: Collaborator description: Collaborator type: object @@ -60085,9 +60777,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '204': description: Response if user is a collaborator @@ -60129,9 +60821,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 requestBody: required: false content: @@ -60157,7 +60849,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &455 + schema: &458 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -60169,7 +60861,7 @@ paths: format: int64 examples: - 42 - repository: *132 + repository: *135 invitee: anyOf: - type: 'null' @@ -60378,9 +61070,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '204': description: No Content when collaborator was removed from the repository. @@ -60409,9 +61101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *280 - - *281 - - *154 + - *283 + - *284 + - *157 responses: '200': description: if user has admin permissions @@ -60431,7 +61123,7 @@ paths: user: anyOf: - type: 'null' - - *391 + - *394 required: - permission - role_name @@ -60485,8 +61177,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -60496,7 +61188,7 @@ paths: application/json: schema: type: array - items: &392 + items: &395 title: Commit Comment description: Commit Comment type: object @@ -60537,8 +61229,8 @@ paths: updated_at: type: string format: date-time - author_association: *85 - reactions: *86 + author_association: *88 + reactions: *89 required: - url - html_url @@ -60554,7 +61246,7 @@ paths: - created_at - updated_at examples: - default: &395 + default: &398 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60613,17 +61305,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *392 + schema: *395 examples: - default: &396 + default: &399 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -60680,9 +61372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -60704,7 +61396,7 @@ paths: description: Response content: application/json: - schema: *392 + schema: *395 examples: default: value: @@ -60755,9 +61447,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -60778,9 +61470,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -60806,9 +61498,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -60829,9 +61521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -60863,16 +61555,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -60894,10 +61586,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -60945,8 +61637,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *280 - - *281 + - *283 + - *284 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -61002,9 +61694,9 @@ paths: application/json: schema: type: array - items: *393 + items: *396 examples: - default: &502 + default: &505 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -61077,7 +61769,7 @@ paths: '500': *69 '400': *14 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61097,9 +61789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *280 - - *281 - - &394 + - *283 + - *284 + - &397 name: commit_sha description: The SHA of the commit. in: path @@ -61146,7 +61838,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61171,9 +61863,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 - *17 - *18 responses: @@ -61183,9 +61875,9 @@ paths: application/json: schema: type: array - items: *392 + items: *395 examples: - default: *395 + default: *398 headers: Link: *37 x-github: @@ -61213,9 +61905,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 requestBody: required: true content: @@ -61250,9 +61942,9 @@ paths: description: Response content: application/json: - schema: *392 + schema: *395 examples: - default: *396 + default: *399 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -61280,9 +61972,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: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 - *17 - *18 responses: @@ -61292,7 +61984,7 @@ paths: application/json: schema: type: array - items: &493 + items: &496 title: Pull Request Simple description: Pull Request Simple type: object @@ -61412,7 +62104,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 active_lock_reason: type: - string @@ -61467,7 +62159,7 @@ paths: type: - array - 'null' - items: *198 + items: *201 head: type: object properties: @@ -61511,7 +62203,7 @@ paths: _links: type: object properties: - comments: &398 + comments: &401 title: Link description: Hypermedia Link type: object @@ -61520,13 +62212,13 @@ paths: type: string required: - href - commits: *398 - statuses: *398 - html: *398 - issue: *398 - review_comments: *398 - review_comment: *398 - self: *398 + commits: *401 + statuses: *401 + html: *401 + issue: *401 + review_comments: *401 + review_comment: *401 + self: *401 required: - comments - commits @@ -61536,8 +62228,8 @@ paths: - review_comments - review_comment - self - author_association: *85 - auto_merge: &495 + author_association: *88 + auto_merge: &498 title: Auto merge description: The status of auto merging a pull request. type: @@ -61602,7 +62294,7 @@ paths: - author_association - auto_merge examples: - default: &494 + default: &497 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -62082,7 +62774,7 @@ paths: draft: false headers: Link: *37 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62138,11 +62830,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 - - &399 + - &402 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)" @@ -62157,9 +62849,9 @@ paths: description: Response content: application/json: - schema: *393 + schema: *396 examples: - default: &481 + default: &484 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -62246,7 +62938,7 @@ paths: '404': *6 '500': *69 '503': *81 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62271,11 +62963,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: - - *280 - - *281 - - *399 - - *400 - - *401 + - *283 + - *284 + - *402 + - *403 + - *404 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -62309,9 +63001,9 @@ paths: type: integer check_runs: type: array - items: *351 + items: *354 examples: - default: *402 + default: *405 headers: Link: *37 x-github: @@ -62336,9 +63028,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: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -62346,7 +63038,7 @@ paths: schema: type: integer example: 1 - - *400 + - *403 - *17 - *18 responses: @@ -62364,7 +63056,7 @@ paths: type: integer check_suites: type: array - items: *355 + items: *358 examples: default: value: @@ -62564,9 +63256,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: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - *17 - *18 responses: @@ -62637,7 +63329,7 @@ paths: type: string total_count: type: integer - repository: *132 + repository: *135 commit_url: type: string format: uri @@ -62768,9 +63460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *280 - - *281 - - *399 + - *283 + - *284 + - *402 - *17 - *18 responses: @@ -62780,7 +63472,7 @@ paths: application/json: schema: type: array - items: &556 + items: &559 title: Status description: The status of a commit. type: object @@ -62861,7 +63553,7 @@ paths: site_admin: false headers: Link: *37 - '301': *294 + '301': *297 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62889,8 +63581,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -62923,11 +63615,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *403 + - *406 code_of_conduct_file: anyOf: - type: 'null' - - &404 + - &407 title: Community Health File type: object properties: @@ -62943,23 +63635,23 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 contributing: anyOf: - type: 'null' - - *404 + - *407 readme: anyOf: - type: 'null' - - *404 + - *407 issue_template: anyOf: - type: 'null' - - *404 + - *407 pull_request_template: anyOf: - type: 'null' - - *404 + - *407 required: - code_of_conduct - code_of_conduct_file @@ -63087,8 +63779,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 - name: basehead @@ -63136,8 +63828,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *393 - merge_base_commit: *393 + base_commit: *396 + merge_base_commit: *396 status: type: string enum: @@ -63161,10 +63853,10 @@ paths: - 6 commits: type: array - items: *393 + items: *396 files: type: array - items: *405 + items: *408 required: - url - html_url @@ -63447,8 +64139,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -63599,7 +64291,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &406 + response-if-content-is-a-file: &409 summary: Response if content is a file value: type: file @@ -63736,7 +64428,7 @@ paths: - size - type - url - - &507 + - &510 title: Content File description: Content File type: object @@ -63954,7 +64646,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *406 + response-if-content-is-a-file: *409 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -64023,7 +64715,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *407 + '302': *410 '304': *35 x-github: githubCloudOnly: false @@ -64046,8 +64738,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -64142,7 +64834,7 @@ paths: description: Response content: application/json: - schema: &408 + schema: &411 title: File Commit description: File Commit type: object @@ -64293,7 +64985,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: example-for-creating-a-file: value: @@ -64346,7 +65038,7 @@ paths: schema: oneOf: - *3 - - &437 + - &440 description: Repository rule violation was detected type: object properties: @@ -64367,7 +65059,7 @@ paths: items: type: object properties: - placeholder_id: &549 + placeholder_id: &552 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -64399,8 +65091,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *280 - - *281 + - *283 + - *284 - name: path description: path parameter in: path @@ -64461,7 +65153,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: default: value: @@ -64494,7 +65186,7 @@ paths: payload: '422': *15 '404': *6 - '409': *119 + '409': *122 '503': *81 x-github: githubCloudOnly: false @@ -64515,8 +65207,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *280 - - *281 + - *283 + - *284 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -64640,20 +65332,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *280 - - *281 - - *173 - - *174 - - *175 + - *283 + - *284 - *176 + - *177 + - *178 + - *179 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *177 - - *178 + - *180 + - *181 - *65 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -64673,8 +65365,8 @@ paths: default: 30 - *63 - *64 - - *179 - - *180 + - *182 + - *183 responses: '200': description: Response @@ -64682,7 +65374,7 @@ paths: application/json: schema: type: array - items: &411 + items: &414 type: object description: A Dependabot alert. properties: @@ -64717,7 +65409,7 @@ paths: - development - runtime - - security_advisory: *409 + security_advisory: *412 security_vulnerability: *73 url: *74 html_url: *75 @@ -64748,7 +65440,7 @@ paths: dismissal. maxLength: 280 fixed_at: *79 - auto_dismissed_at: *410 + auto_dismissed_at: *413 required: - number - state @@ -64975,9 +65667,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *280 - - *281 - - &412 + - *283 + - *284 + - &415 name: alert_number in: path description: |- @@ -64992,7 +65684,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *414 examples: default: value: @@ -65102,9 +65794,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *280 - - *281 - - *412 + - *283 + - *284 + - *415 requestBody: required: true content: @@ -65149,7 +65841,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *414 examples: default: value: @@ -65255,7 +65947,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *119 + '409': *122 '422': *7 x-github: githubCloudOnly: false @@ -65278,8 +65970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -65297,7 +65989,7 @@ paths: type: integer secrets: type: array - items: &415 + items: &418 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -65351,16 +66043,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *413 + schema: *416 examples: - default: *414 + default: *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65380,15 +66072,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: default: value: @@ -65414,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 requestBody: required: true content: @@ -65444,7 +66136,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -65468,9 +66160,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *280 - - *281 - - *142 + - *283 + - *284 + - *145 responses: '204': description: Response @@ -65492,8 +66184,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: - - *280 - - *281 + - *283 + - *284 - 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 @@ -65667,8 +66359,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -65891,8 +66583,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -65975,7 +66667,7 @@ paths: - version - url additionalProperties: false - metadata: &416 + metadata: &419 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -66014,7 +66706,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *416 + metadata: *419 resolved: type: object description: A collection of resolved package dependencies. @@ -66028,7 +66720,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *416 + metadata: *419 relationship: type: string description: A notation of whether a dependency is requested @@ -66161,8 +66853,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *280 - - *281 + - *283 + - *284 - name: sha description: The SHA recorded at creation time. in: query @@ -66203,9 +66895,9 @@ paths: application/json: schema: type: array - items: *417 + items: *420 examples: - default: *418 + default: *421 headers: Link: *37 x-github: @@ -66271,8 +66963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -66354,7 +67046,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: simple-example: summary: Simple example @@ -66427,9 +67119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *280 - - *281 - - &419 + - *283 + - *284 + - &422 name: deployment_id description: deployment_id parameter in: path @@ -66441,7 +67133,7 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: default: value: @@ -66506,9 +67198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 responses: '204': description: Response @@ -66530,9 +67222,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 - *17 - *18 responses: @@ -66542,7 +67234,7 @@ paths: application/json: schema: type: array - items: &420 + items: &423 title: Deployment Status description: The status of a deployment. type: object @@ -66706,9 +67398,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 requestBody: required: true content: @@ -66783,9 +67475,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: &421 + default: &424 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -66841,9 +67533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *280 - - *281 - - *419 + - *283 + - *284 + - *422 - name: status_id in: path required: true @@ -66854,9 +67546,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: *421 + default: *424 '404': *6 x-github: githubCloudOnly: false @@ -66881,8 +67573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -66939,8 +67631,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -66958,7 +67650,7 @@ paths: - 5 environments: type: array - items: &423 + items: &426 title: Environment description: Details of a deployment environment type: object @@ -67020,7 +67712,7 @@ paths: type: string examples: - wait_timer - wait_timer: &425 + wait_timer: &428 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -67062,11 +67754,11 @@ paths: items: type: object properties: - type: *422 + type: *425 reviewer: anyOf: - *4 - - *198 + - *201 required: - id - node_id @@ -67089,7 +67781,7 @@ paths: - id - node_id - type - deployment_branch_policy: &426 + deployment_branch_policy: &429 type: - object - 'null' @@ -67206,9 +67898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *280 - - *281 - - &424 + - *283 + - *284 + - &427 name: environment_name in: path required: true @@ -67221,9 +67913,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: &427 + default: &430 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -67307,9 +67999,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: false content: @@ -67319,7 +68011,7 @@ paths: - object - 'null' properties: - wait_timer: *425 + wait_timer: *428 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -67338,14 +68030,14 @@ paths: items: type: object properties: - type: *422 + type: *425 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *426 + deployment_branch_policy: *429 additionalProperties: false examples: default: @@ -67365,9 +68057,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *427 + default: *430 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -67391,9 +68083,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 responses: '204': description: Default response @@ -67418,9 +68110,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 - *17 - *18 responses: @@ -67439,7 +68131,7 @@ paths: - 2 branch_policies: type: array - items: &428 + items: &431 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -67500,9 +68192,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: true content: @@ -67550,9 +68242,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - example-wildcard: &429 + example-wildcard: &432 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -67594,10 +68286,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - &430 + - *283 + - *284 + - *427 + - &433 name: branch_policy_id in: path required: true @@ -67609,9 +68301,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67630,10 +68322,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - *430 + - *283 + - *284 + - *427 + - *433 requestBody: required: true content: @@ -67662,9 +68354,9 @@ paths: description: Response content: application/json: - schema: *428 + schema: *431 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67683,10 +68375,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *280 - - *281 - - *424 - - *430 + - *283 + - *284 + - *427 + - *433 responses: '204': description: Response @@ -67711,9 +68403,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 responses: '200': description: List of deployment protection rules @@ -67730,7 +68422,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &431 + items: &434 title: Deployment protection rule description: Deployment protection rule type: object @@ -67752,7 +68444,7 @@ paths: for the environment. examples: - true - app: &432 + app: &435 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -67855,9 +68547,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 requestBody: content: application/json: @@ -67878,9 +68570,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *431 + schema: *434 examples: - default: &433 + default: &436 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -67915,9 +68607,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: - - *424 - - *281 - - *280 + - *427 + - *284 + - *283 - *18 - *17 responses: @@ -67937,7 +68629,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *432 + items: *435 examples: default: value: @@ -67972,10 +68664,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: - - *280 - - *281 - - *424 - - &434 + - *283 + - *284 + - *427 + - &437 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -67987,9 +68679,9 @@ paths: description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *433 + default: *436 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68010,10 +68702,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: - - *424 - - *281 - - *280 - - *434 + - *427 + - *284 + - *283 + - *437 responses: '204': description: Response @@ -68039,9 +68731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 - *17 - *18 responses: @@ -68059,9 +68751,9 @@ paths: type: integer secrets: type: array - items: *317 + items: *320 examples: - default: *318 + default: *321 headers: Link: *37 x-github: @@ -68086,17 +68778,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 responses: '200': description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *320 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68118,18 +68810,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 responses: '200': description: Response content: application/json: - schema: *317 + schema: *320 examples: - default: *435 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68151,10 +68843,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 requestBody: required: true content: @@ -68185,7 +68877,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -68211,10 +68903,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *280 - - *281 - - *424 - - *142 + - *283 + - *284 + - *427 + - *145 responses: '204': description: Default response @@ -68239,10 +68931,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *280 - - *281 - - *424 - - *304 + - *283 + - *284 + - *427 + - *307 - *18 responses: '200': @@ -68259,9 +68951,9 @@ paths: type: integer variables: type: array - items: *321 + items: *324 examples: - default: *322 + default: *325 headers: Link: *37 x-github: @@ -68284,9 +68976,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *280 - - *281 - - *424 + - *283 + - *284 + - *427 requestBody: required: true content: @@ -68313,7 +69005,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -68338,18 +69030,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *280 - - *281 - - *424 - - *145 + - *283 + - *284 + - *427 + - *148 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: *436 + default: *439 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68370,10 +69062,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *280 - - *281 - - *145 - - *424 + - *283 + - *284 + - *148 + - *427 requestBody: required: true content: @@ -68415,10 +69107,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *280 - - *281 - - *145 - - *424 + - *283 + - *284 + - *148 + - *427 responses: '204': description: Response @@ -68440,8 +69132,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -68451,7 +69143,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: 200-response: value: @@ -68518,8 +69210,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *280 - - *281 + - *283 + - *284 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -68541,7 +69233,7 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: default: value: @@ -68678,8 +69370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -68712,9 +69404,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 '400': *14 '422': *15 '403': *27 @@ -68735,8 +69427,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -68787,7 +69479,7 @@ paths: schema: type: string '404': *6 - '409': *119 + '409': *122 '403': *27 '422': description: Validation failed @@ -68795,8 +69487,8 @@ paths: application/json: schema: oneOf: - - *117 - - *437 + - *120 + - *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68821,8 +69513,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *280 - - *281 + - *283 + - *284 - name: file_sha in: path required: true @@ -68874,7 +69566,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68921,8 +69613,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69031,7 +69723,7 @@ paths: description: Response content: application/json: - schema: &438 + schema: &441 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -69202,7 +69894,7 @@ paths: type: string '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69251,15 +69943,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *280 - - *281 - - *394 + - *283 + - *284 + - *397 responses: '200': description: Response content: application/json: - schema: *438 + schema: *441 examples: default: value: @@ -69289,7 +69981,7 @@ paths: signature: payload: '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69314,9 +70006,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *280 - - *281 - - &439 + - *283 + - *284 + - &442 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. @@ -69333,7 +70025,7 @@ paths: application/json: schema: type: array - items: &440 + items: &443 title: Git Reference description: Git references within a repository type: object @@ -69388,7 +70080,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69409,17 +70101,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 responses: '200': description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: &441 + default: &444 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -69429,7 +70121,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69448,8 +70140,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69478,16 +70170,16 @@ paths: description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: *441 + default: *444 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69506,9 +70198,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 requestBody: required: true content: @@ -69537,11 +70229,11 @@ paths: description: Response content: application/json: - schema: *440 + schema: *443 examples: - default: *441 + default: *444 '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69557,14 +70249,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *280 - - *281 - - *439 + - *283 + - *284 + - *442 responses: '204': description: Response '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69611,8 +70303,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69679,7 +70371,7 @@ paths: description: Response content: application/json: - schema: &443 + schema: &446 title: Git Tag description: Metadata for a Git tag type: object @@ -69735,7 +70427,7 @@ paths: - sha - type - url - verification: *442 + verification: *445 required: - sha - url @@ -69745,7 +70437,7 @@ paths: - tag - message examples: - default: &444 + default: &447 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -69771,7 +70463,7 @@ paths: schema: type: string '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69816,8 +70508,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *280 - - *281 + - *283 + - *284 - name: tag_sha in: path required: true @@ -69828,11 +70520,11 @@ paths: description: Response content: application/json: - schema: *443 + schema: *446 examples: - default: *444 + default: *447 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69854,8 +70546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -69929,7 +70621,7 @@ paths: description: Response content: application/json: - schema: &445 + schema: &448 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -70024,7 +70716,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70047,8 +70739,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *280 - - *281 + - *283 + - *284 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -70071,7 +70763,7 @@ paths: description: Response content: application/json: - schema: *445 + schema: *448 examples: default-response: summary: Default response @@ -70112,7 +70804,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70130,8 +70822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -70141,7 +70833,7 @@ paths: application/json: schema: type: array - items: &446 + items: &449 title: Webhook description: Webhooks for repositories. type: object @@ -70204,7 +70896,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &682 + last_response: &685 title: Hook Response type: object properties: @@ -70281,8 +70973,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -70335,9 +71027,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: &447 + default: &450 value: type: Repository id: 12345678 @@ -70385,17 +71077,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '200': description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 '404': *6 x-github: githubCloudOnly: false @@ -70415,9 +71107,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 requestBody: required: true content: @@ -70462,9 +71154,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 '422': *15 '404': *6 x-github: @@ -70482,9 +71174,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70508,9 +71200,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '200': description: Response @@ -70537,9 +71229,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 requestBody: required: false content: @@ -70583,11 +71275,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *17 - - *187 + - *190 - name: redelivery in: query required: false @@ -70600,9 +71292,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '400': *14 '422': *15 x-github: @@ -70621,18 +71313,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: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *16 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: - default: *191 + default: *194 '400': *14 '422': *15 x-github: @@ -70651,12 +71343,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 - *16 responses: - '202': *120 + '202': *123 '400': *14 '422': *15 x-github: @@ -70676,9 +71368,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70703,9 +71395,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *280 - - *281 - - *186 + - *283 + - *284 + - *189 responses: '204': description: Response @@ -70763,14 +71455,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &448 + schema: &451 title: Import description: A repository import from an external source. type: object @@ -70877,7 +71569,7 @@ paths: - html_url - authors_url examples: - default: &451 + default: &454 value: vcs: subversion use_lfs: true @@ -70893,7 +71585,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': &449 + '503': &452 description: Unavailable due to service under maintenance. content: application/json: @@ -70922,8 +71614,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -70971,7 +71663,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: default: value: @@ -70996,7 +71688,7 @@ paths: type: string '422': *15 '404': *6 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71024,8 +71716,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -71077,7 +71769,7 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: example-1: summary: Example 1 @@ -71125,7 +71817,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': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71148,12 +71840,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71179,9 +71871,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *280 - - *281 - - &631 + - *283 + - *284 + - &634 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -71195,7 +71887,7 @@ paths: application/json: schema: type: array - items: &450 + items: &453 title: Porter Author description: Porter Author type: object @@ -71249,7 +71941,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': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71274,8 +71966,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *280 - - *281 + - *283 + - *284 - name: author_id in: path required: true @@ -71305,7 +71997,7 @@ paths: description: Response content: application/json: - schema: *450 + schema: *453 examples: default: value: @@ -71318,7 +72010,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71342,8 +72034,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71384,7 +72076,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71412,8 +72104,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -71440,11 +72132,11 @@ paths: description: Response content: application/json: - schema: *448 + schema: *451 examples: - default: *451 + default: *454 '422': *15 - '503': *449 + '503': *452 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71467,8 +72159,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71476,8 +72168,8 @@ paths: application/json: schema: *20 examples: - default: *452 - '301': *294 + default: *455 + '301': *297 '404': *6 x-github: githubCloudOnly: false @@ -71497,8 +72189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -71506,12 +72198,12 @@ paths: application/json: schema: anyOf: - - *193 + - *196 - type: object properties: {} additionalProperties: false examples: - default: &454 + default: &457 value: limit: collaborators_only origin: repository @@ -71536,13 +72228,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: application/json: - schema: *453 + schema: *456 examples: default: summary: Example request body @@ -71554,9 +72246,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *454 + default: *457 '409': description: Response x-github: @@ -71578,8 +72270,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -71602,8 +72294,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -71613,9 +72305,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: &624 + default: &627 value: - id: 1 repository: @@ -71746,9 +72438,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *280 - - *281 - - *197 + - *283 + - *284 + - *200 requestBody: required: false content: @@ -71777,7 +72469,7 @@ paths: description: Response content: application/json: - schema: *455 + schema: *458 examples: default: value: @@ -71908,9 +72600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *280 - - *281 - - *197 + - *283 + - *284 + - *200 responses: '204': description: Response @@ -71941,8 +72633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *280 - - *281 + - *283 + - *284 - 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 @@ -71982,7 +72674,7 @@ paths: required: false schema: type: string - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -71995,7 +72687,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -72005,7 +72697,7 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: default: value: @@ -72155,7 +72847,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *294 + '301': *297 '422': *15 '404': *6 x-github: @@ -72184,8 +72876,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -72266,9 +72958,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: &459 + default: &462 value: id: 1 node_id: MDU6SXNzdWUx @@ -72424,7 +73116,7 @@ paths: '422': *15 '503': *81 '404': *6 - '410': *291 + '410': *294 x-github: triggersNotification: true githubCloudOnly: false @@ -72452,9 +73144,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *280 - - *281 - - *107 + - *283 + - *284 + - *110 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -72464,7 +73156,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -72474,9 +73166,9 @@ paths: application/json: schema: type: array - items: *456 + items: *459 examples: - default: &461 + default: &464 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -72534,17 +73226,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: &457 + default: &460 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -72598,9 +73290,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -72622,9 +73314,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '422': *15 x-github: githubCloudOnly: false @@ -72642,9 +73334,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -72664,9 +73356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -72692,9 +73384,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -72715,9 +73407,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -72749,16 +73441,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -72780,10 +73472,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -72803,8 +73495,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -72814,7 +73506,7 @@ paths: application/json: schema: type: array - items: &458 + items: &461 title: Issue Event description: Issue Event type: object @@ -72861,7 +73553,7 @@ paths: issue: anyOf: - type: 'null' - - *98 + - *101 label: title: Issue Event Label description: Issue Event Label @@ -72894,7 +73586,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *198 + requested_team: *201 dismissed_review: title: Issue Event Dismissed Review type: object @@ -72961,7 +73653,7 @@ paths: required: - from - to - author_association: *85 + author_association: *88 lock_reason: type: - string @@ -73153,8 +73845,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *280 - - *281 + - *283 + - *284 - name: event_id in: path required: true @@ -73165,7 +73857,7 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: default: value: @@ -73358,7 +74050,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *291 + '410': *294 '403': *27 x-github: githubCloudOnly: false @@ -73392,9 +74084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *280 - - *281 - - &460 + - *283 + - *284 + - &463 name: issue_number description: The number that identifies the issue. in: path @@ -73406,12 +74098,12 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 - '301': *294 + default: *462 + '301': *297 '404': *6 - '410': *291 + '410': *294 '304': *35 x-github: githubCloudOnly: false @@ -73436,9 +74128,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -73546,15 +74238,15 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 '422': *15 '503': *81 '403': *27 - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73572,9 +74264,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -73600,9 +74292,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73618,9 +74310,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: content: application/json: @@ -73645,9 +74337,9 @@ paths: description: Response content: application/json: - schema: *98 + schema: *101 examples: - default: *459 + default: *462 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73669,9 +74361,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: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - name: assignee in: path required: true @@ -73711,10 +74403,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *280 - - *281 - - *460 - - *88 + - *283 + - *284 + - *463 + - *91 - *17 - *18 responses: @@ -73724,13 +74416,13 @@ paths: application/json: schema: type: array - items: *456 + items: *459 examples: - default: *461 + default: *464 headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73759,9 +74451,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: true content: @@ -73783,16 +74475,16 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *291 + '410': *294 '422': *15 '404': *6 x-github: @@ -73812,9 +74504,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -73828,7 +74520,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &464 + - &467 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -73877,7 +74569,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &465 + - &468 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -74005,7 +74697,7 @@ paths: - performed_via_github_app - assignee - assigner - - &466 + - &469 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -74051,7 +74743,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &467 + - &470 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -74097,7 +74789,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &468 + - &471 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -74146,7 +74838,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &469 + - &472 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -74175,7 +74867,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *198 + requested_team: *201 requested_reviewer: *4 required: - review_requester @@ -74188,7 +74880,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &470 + - &473 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -74217,7 +74909,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *198 + requested_team: *201 requested_reviewer: *4 required: - review_requester @@ -74230,7 +74922,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &471 + - &474 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -74286,7 +74978,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &472 + - &475 title: Locked Issue Event description: Locked Issue Event type: object @@ -74331,7 +75023,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &473 + - &476 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -74392,7 +75084,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &474 + - &477 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -74453,7 +75145,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &475 + - &478 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -74514,7 +75206,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &476 + - &479 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -74607,7 +75299,7 @@ paths: color: red headers: Link: *37 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74624,9 +75316,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -74636,7 +75328,7 @@ paths: application/json: schema: type: array - items: &462 + items: &465 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -74691,7 +75383,7 @@ paths: - color - default examples: - default: &463 + default: &466 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74709,9 +75401,9 @@ paths: default: false headers: Link: *37 - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74728,9 +75420,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -74789,12 +75481,12 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 - '301': *294 + default: *466 + '301': *297 '404': *6 - '410': *291 + '410': *294 '422': *15 x-github: githubCloudOnly: false @@ -74811,9 +75503,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -74873,12 +75565,12 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 - '301': *294 + default: *466 + '301': *297 '404': *6 - '410': *291 + '410': *294 '422': *15 x-github: githubCloudOnly: false @@ -74895,15 +75587,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 responses: '204': description: Response - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74922,9 +75614,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - name: name in: path required: true @@ -74937,7 +75629,7 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: default: value: @@ -74948,9 +75640,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *294 + '301': *297 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74970,9 +75662,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: false content: @@ -75001,7 +75693,7 @@ paths: '204': description: Response '403': *27 - '410': *291 + '410': *294 '404': *6 '422': *15 x-github: @@ -75019,9 +75711,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 responses: '204': description: Response @@ -75043,9 +75735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - 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. @@ -75071,13 +75763,13 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75095,9 +75787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 requestBody: required: true content: @@ -75129,16 +75821,16 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -75160,10 +75852,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *280 - - *281 - - *460 - - *272 + - *283 + - *284 + - *463 + - *275 responses: '204': description: Response @@ -75183,9 +75875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *280 - - *281 - - *460 + - *283 + - *284 + - *463 - *17 - *18 responses: @@ -75200,9 +75892,6 @@ paths: description: Timeline Event type: object anyOf: - - *464 - - *465 - - *466 - *467 - *468 - *469 @@ -75213,6 +75902,9 @@ paths: - *474 - *475 - *476 + - *477 + - *478 + - *479 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -75260,12 +75952,12 @@ paths: issue_url: type: string format: uri - author_association: *85 + author_association: *88 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - event - actor @@ -75296,7 +75988,7 @@ paths: properties: type: type: string - issue: *98 + issue: *101 required: - event - created_at @@ -75508,7 +76200,7 @@ paths: type: string body_text: type: string - author_association: *85 + author_association: *88 required: - event - id @@ -75531,7 +76223,7 @@ paths: type: string comments: type: array - items: &496 + items: &499 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -75636,7 +76328,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *85 + author_association: *88 _links: type: object properties: @@ -75731,7 +76423,7 @@ paths: enum: - line - file - reactions: *86 + reactions: *89 body_html: type: string examples: @@ -75769,7 +76461,7 @@ paths: type: string comments: type: array - items: *392 + items: *395 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -76044,7 +76736,7 @@ paths: headers: Link: *37 '404': *6 - '410': *291 + '410': *294 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76061,8 +76753,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -76072,7 +76764,7 @@ paths: application/json: schema: type: array - items: &477 + items: &480 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -76136,8 +76828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76173,9 +76865,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: &478 + default: &481 value: id: 1 key: ssh-rsa AAA... @@ -76208,9 +76900,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *280 - - *281 - - &479 + - *283 + - *284 + - &482 name: key_id description: The unique identifier of the key. in: path @@ -76222,9 +76914,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: *478 + default: *481 '404': *6 x-github: githubCloudOnly: false @@ -76242,9 +76934,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *280 - - *281 - - *479 + - *283 + - *284 + - *482 responses: '204': description: Response @@ -76264,8 +76956,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -76275,9 +76967,9 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 + default: *466 headers: Link: *37 '404': *6 @@ -76298,8 +76990,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76335,9 +77027,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: &480 + default: &483 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -76369,8 +77061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76381,9 +77073,9 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: - default: *480 + default: *483 '404': *6 x-github: githubCloudOnly: false @@ -76400,8 +77092,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76440,7 +77132,7 @@ paths: description: Response content: application/json: - schema: *462 + schema: *465 examples: default: value: @@ -76466,8 +77158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *280 - - *281 + - *283 + - *284 - name: name in: path required: true @@ -76493,8 +77185,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -76530,10 +77222,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '202': *120 + '202': *123 '403': description: |- We will return a 403 with one of the following messages: @@ -76559,8 +77251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -76586,9 +77278,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *280 - - *281 - - *369 + - *283 + - *284 + - *372 responses: '200': description: Response @@ -76654,7 +77346,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 required: - _links - git_url @@ -76735,8 +77427,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76801,8 +77493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -76836,9 +77528,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *393 + schema: *396 examples: - default: *481 + default: *484 '204': description: Response when already merged '404': @@ -76863,8 +77555,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -76905,7 +77597,7 @@ paths: application/json: schema: type: array - items: *397 + items: *400 examples: default: value: @@ -76961,8 +77653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77002,9 +77694,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: &482 + default: &485 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -77063,9 +77755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *280 - - *281 - - &483 + - *283 + - *284 + - &486 name: milestone_number description: The number that identifies the milestone. in: path @@ -77077,9 +77769,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *482 + default: *485 '404': *6 x-github: githubCloudOnly: false @@ -77096,9 +77788,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 requestBody: required: false content: @@ -77136,9 +77828,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *482 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77154,9 +77846,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 responses: '204': description: Response @@ -77177,9 +77869,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: - - *280 - - *281 - - *483 + - *283 + - *284 + - *486 - *17 - *18 responses: @@ -77189,9 +77881,9 @@ paths: application/json: schema: type: array - items: *462 + items: *465 examples: - default: *463 + default: *466 headers: Link: *37 x-github: @@ -77210,12 +77902,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: - - *280 - - *281 - - *484 - - *485 - - *88 - - *486 + - *283 + - *284 + - *487 + - *488 + - *91 + - *489 - *17 - *18 responses: @@ -77225,9 +77917,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *487 + default: *490 headers: Link: *37 x-github: @@ -77251,8 +77943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -77310,14 +78002,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: &488 + schema: &491 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -77461,7 +78153,7 @@ paths: - custom_404 - public examples: - default: &489 + default: &492 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -77502,8 +78194,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77558,11 +78250,11 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: *489 + default: *492 '422': *15 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77583,8 +78275,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -77671,7 +78363,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77692,14 +78384,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response '422': *15 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77719,8 +78411,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -77730,7 +78422,7 @@ paths: application/json: schema: type: array - items: &490 + items: &493 title: Page Build description: Page Build type: object @@ -77822,8 +78514,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *280 - - *281 + - *283 + - *284 responses: '201': description: Response @@ -77870,16 +78562,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: &491 + default: &494 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -77927,8 +78619,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *280 - - *281 + - *283 + - *284 - name: build_id in: path required: true @@ -77939,9 +78631,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *491 + default: *494 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77961,8 +78653,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78071,9 +78763,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: - - *280 - - *281 - - &492 + - *283 + - *284 + - &495 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -78131,11 +78823,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *280 - - *281 - - *492 + - *283 + - *284 + - *495 responses: - '204': *163 + '204': *166 '404': *6 x-github: githubCloudOnly: false @@ -78160,8 +78852,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -78429,7 +79121,7 @@ paths: description: Empty response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -78456,8 +79148,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Private vulnerability reporting status @@ -78494,10 +79186,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '204': *163 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -78516,10 +79208,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *280 - - *281 + - *283 + - *284 responses: - '204': *163 + '204': *166 '422': *14 x-github: githubCloudOnly: false @@ -78540,8 +79232,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: Indicates the state of the projects to return. in: query @@ -78562,7 +79254,7 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: default: value: @@ -78602,7 +79294,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -78622,8 +79314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78649,13 +79341,13 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *290 + default: *293 '401': *23 '403': *27 '404': *6 - '410': *291 + '410': *294 '422': *7 x-github: githubCloudOnly: false @@ -78675,8 +79367,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -78684,7 +79376,7 @@ paths: application/json: schema: type: array - items: *231 + items: *234 examples: default: value: @@ -78715,8 +79407,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78728,7 +79420,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *231 + items: *234 required: - properties examples: @@ -78778,8 +79470,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *280 - - *281 + - *283 + - *284 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -78839,9 +79531,9 @@ paths: application/json: schema: type: array - items: *493 + items: *496 examples: - default: *494 + default: *497 headers: Link: *37 '304': *35 @@ -78873,8 +79565,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -78941,7 +79633,7 @@ paths: description: Response content: application/json: - schema: &498 + schema: &501 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -79070,7 +79762,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 active_lock_reason: type: - string @@ -79125,7 +79817,7 @@ paths: type: - array - 'null' - items: *211 + items: *214 head: type: object properties: @@ -79163,14 +79855,14 @@ paths: _links: type: object properties: - comments: *398 - commits: *398 - statuses: *398 - html: *398 - issue: *398 - review_comments: *398 - review_comment: *398 - self: *398 + comments: *401 + commits: *401 + statuses: *401 + html: *401 + issue: *401 + review_comments: *401 + review_comment: *401 + self: *401 required: - comments - commits @@ -79180,8 +79872,8 @@ paths: - review_comments - review_comment - self - author_association: *85 - auto_merge: *495 + author_association: *88 + auto_merge: *498 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -79283,7 +79975,7 @@ paths: - merged_by - review_comments examples: - default: &499 + default: &502 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -79810,8 +80502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *280 - - *281 + - *283 + - *284 - name: sort in: query required: false @@ -79830,7 +80522,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -79840,9 +80532,9 @@ paths: application/json: schema: type: array - items: *496 + items: *499 examples: - default: &501 + default: &504 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -79919,17 +80611,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '200': description: Response content: application/json: - schema: *496 + schema: *499 examples: - default: &497 + default: &500 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -80004,9 +80696,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -80028,9 +80720,9 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: - default: *497 + default: *500 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80046,9 +80738,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 responses: '204': description: Response @@ -80069,9 +80761,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 - 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. @@ -80097,9 +80789,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -80120,9 +80812,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: - - *280 - - *281 - - *97 + - *283 + - *284 + - *100 requestBody: required: true content: @@ -80154,16 +80846,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -80185,10 +80877,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *280 - - *281 - - *97 - - *272 + - *283 + - *284 + - *100 + - *275 responses: '204': description: Response @@ -80231,9 +80923,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *280 - - *281 - - &500 + - *283 + - *284 + - &503 name: pull_number description: The number that identifies the pull request. in: path @@ -80246,9 +80938,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *498 + schema: *501 examples: - default: *499 + default: *502 '304': *35 '404': *6 '406': @@ -80283,9 +80975,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -80327,9 +81019,9 @@ paths: description: Response content: application/json: - schema: *498 + schema: *501 examples: - default: *499 + default: *502 '422': *15 '403': *27 x-github: @@ -80351,9 +81043,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -80414,17 +81106,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -80454,10 +81146,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: - - *280 - - *281 - - *500 - - *107 + - *283 + - *284 + - *503 + - *110 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -80467,7 +81159,7 @@ paths: enum: - asc - desc - - *88 + - *91 - *17 - *18 responses: @@ -80477,9 +81169,9 @@ paths: application/json: schema: type: array - items: *496 + items: *499 examples: - default: *501 + default: *504 headers: Link: *37 x-github: @@ -80512,9 +81204,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -80620,7 +81312,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: example-for-a-multi-line-comment: value: @@ -80708,10 +81400,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: - - *280 - - *281 - - *500 - - *97 + - *283 + - *284 + - *503 + - *100 requestBody: required: true content: @@ -80733,7 +81425,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *499 examples: default: value: @@ -80819,9 +81511,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -80831,9 +81523,9 @@ paths: application/json: schema: type: array - items: *393 + items: *396 examples: - default: *502 + default: *505 headers: Link: *37 x-github: @@ -80863,9 +81555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -80875,7 +81567,7 @@ paths: application/json: schema: type: array - items: *405 + items: *408 examples: default: value: @@ -80913,9 +81605,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 responses: '204': description: Response if pull request has been merged @@ -80938,9 +81630,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -81052,9 +81744,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 responses: '200': description: Response @@ -81070,7 +81762,7 @@ paths: items: *4 teams: type: array - items: *198 + items: *201 required: - users - teams @@ -81129,9 +81821,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -81168,7 +81860,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *496 examples: default: value: @@ -81704,9 +82396,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: true content: @@ -81740,7 +82432,7 @@ paths: description: Response content: application/json: - schema: *493 + schema: *496 examples: default: value: @@ -82245,9 +82937,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 - *17 - *18 responses: @@ -82257,7 +82949,7 @@ paths: application/json: schema: type: array - items: &503 + items: &506 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -82331,7 +83023,7 @@ paths: type: string body_text: type: string - author_association: *85 + author_association: *88 required: - id - node_id @@ -82413,9 +83105,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: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -82505,9 +83197,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: &505 + default: &508 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82570,10 +83262,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: - - *280 - - *281 - - *500 - - &504 + - *283 + - *284 + - *503 + - &507 name: review_id description: The unique identifier of the review. in: path @@ -82585,9 +83277,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: &506 + default: &509 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -82646,10 +83338,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -82672,7 +83364,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: default: value: @@ -82734,18 +83426,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 responses: '200': description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: *505 + default: *508 '422': *7 '404': *6 x-github: @@ -82772,10 +83464,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 - *17 - *18 responses: @@ -82869,13 +83561,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *85 + author_association: *88 _links: type: object properties: - self: *398 - html: *398 - pull_request: *398 + self: *401 + html: *401 + pull_request: *401 required: - self - html @@ -82884,7 +83576,7 @@ paths: type: string body_html: type: string - reactions: *86 + reactions: *89 side: description: The side of the first line of the range for a multi-line comment. @@ -83026,10 +83718,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -83058,7 +83750,7 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: default: value: @@ -83121,10 +83813,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: - - *280 - - *281 - - *500 - - *504 + - *283 + - *284 + - *503 + - *507 requestBody: required: true content: @@ -83159,9 +83851,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *506 examples: - default: *506 + default: *509 '404': *6 '422': *7 '403': *27 @@ -83183,9 +83875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *280 - - *281 - - *500 + - *283 + - *284 + - *503 requestBody: required: false content: @@ -83249,8 +83941,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *280 - - *281 + - *283 + - *284 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -83263,9 +83955,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: - default: &508 + default: &511 value: type: file encoding: base64 @@ -83307,8 +83999,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: - - *280 - - *281 + - *283 + - *284 - name: dir description: The alternate path to look for a README file in: path @@ -83328,9 +84020,9 @@ paths: description: Response content: application/json: - schema: *507 + schema: *510 examples: - default: *508 + default: *511 '404': *6 '422': *15 x-github: @@ -83352,8 +84044,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -83363,7 +84055,7 @@ paths: application/json: schema: type: array - items: &509 + items: &512 title: Release description: A release. type: object @@ -83435,7 +84127,7 @@ paths: author: *4 assets: type: array - items: &510 + items: &513 title: Release Asset description: Data related to a release. type: object @@ -83505,7 +84197,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *86 + reactions: *89 required: - assets_url - upload_url @@ -83615,8 +84307,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -83692,9 +84384,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: &513 + default: &516 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -83795,9 +84487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *280 - - *281 - - &511 + - *283 + - *284 + - &514 name: asset_id description: The unique identifier of the asset. in: path @@ -83809,9 +84501,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: &512 + default: &515 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 @@ -83845,7 +84537,7 @@ paths: type: User site_admin: false '404': *6 - '302': *407 + '302': *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83861,9 +84553,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *280 - - *281 - - *511 + - *283 + - *284 + - *514 requestBody: required: false content: @@ -83892,9 +84584,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *513 examples: - default: *512 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83910,9 +84602,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *280 - - *281 - - *511 + - *283 + - *284 + - *514 responses: '204': description: Response @@ -83936,8 +84628,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -84023,16 +84715,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84049,8 +84741,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *280 - - *281 + - *283 + - *284 - name: tag description: tag parameter in: path @@ -84063,9 +84755,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 '404': *6 x-github: githubCloudOnly: false @@ -84087,9 +84779,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *280 - - *281 - - &514 + - *283 + - *284 + - &517 name: release_id description: The unique identifier of the release. in: path @@ -84103,9 +84795,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: *509 + schema: *512 examples: - default: *513 + default: *516 '401': description: Unauthorized x-github: @@ -84123,9 +84815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 requestBody: required: false content: @@ -84189,9 +84881,9 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *513 + default: *516 '404': description: Not Found if the discussion category name is invalid content: @@ -84212,9 +84904,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 responses: '204': description: Response @@ -84234,9 +84926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - *17 - *18 responses: @@ -84246,7 +84938,7 @@ paths: application/json: schema: type: array - items: *510 + items: *513 examples: default: value: @@ -84327,9 +85019,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: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - name: name in: query required: true @@ -84355,7 +85047,7 @@ paths: description: Response for successful upload content: application/json: - schema: *510 + schema: *513 examples: response-for-successful-upload: value: @@ -84409,9 +85101,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 - 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. @@ -84435,9 +85127,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 '404': *6 @@ -84458,9 +85150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *280 - - *281 - - *514 + - *283 + - *284 + - *517 requestBody: required: true content: @@ -84490,16 +85182,16 @@ paths: description: Reaction exists content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '201': description: Reaction created content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 '422': *15 x-github: githubCloudOnly: false @@ -84521,10 +85213,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *280 - - *281 - - *514 - - *272 + - *283 + - *284 + - *517 + - *275 responses: '204': description: Response @@ -84548,9 +85240,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *280 - - *281 - - *339 + - *283 + - *284 + - *342 - *17 - *18 responses: @@ -84566,8 +85258,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *515 - - &517 + - *518 + - &520 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -84586,54 +85278,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *516 - - *517 - - allOf: - - *518 - - *517 - allOf: - *519 - - *517 - - allOf: - *520 - - *517 - allOf: - *521 - - *517 + - *520 - allOf: - *522 - - *517 + - *520 - allOf: - *523 - - *517 + - *520 - allOf: - *524 - - *517 + - *520 - allOf: - *525 - - *517 + - *520 - allOf: - *526 - - *517 + - *520 - allOf: - *527 - - *517 + - *520 - allOf: - *528 - - *517 + - *520 - allOf: - *529 - - *517 + - *520 - allOf: - *530 - - *517 + - *520 - allOf: - *531 - - *517 + - *520 - allOf: - *532 - - *517 + - *520 + - allOf: + - *533 + - *520 + - allOf: + - *534 + - *520 + - allOf: + - *535 + - *520 examples: default: value: @@ -84672,8 +85364,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 - name: includes_parents @@ -84684,7 +85376,7 @@ paths: schema: type: boolean default: true - - *533 + - *536 responses: '200': description: Response @@ -84692,7 +85384,7 @@ paths: application/json: schema: type: array - items: *241 + items: *244 examples: default: value: @@ -84739,8 +85431,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 requestBody: description: Request body required: true @@ -84760,16 +85452,16 @@ paths: - tag - push default: branch - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *235 + items: *241 + conditions: *238 rules: type: array description: An array of rules within the ruleset. - items: *240 + items: *243 required: - name - enforcement @@ -84800,9 +85492,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: &543 + default: &546 value: id: 42 name: super cool ruleset @@ -84849,12 +85541,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *280 - - *281 - - *534 - - *535 - - *536 + - *283 + - *284 - *537 + - *538 + - *539 + - *540 - *17 - *18 responses: @@ -84862,9 +85554,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *541 examples: - default: *539 + default: *542 '404': *6 '500': *69 x-github: @@ -84885,17 +85577,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *280 - - *281 - - *540 + - *283 + - *284 + - *543 responses: '200': description: Response content: application/json: - schema: *541 + schema: *544 examples: - default: *542 + default: *545 '404': *6 '500': *69 x-github: @@ -84923,8 +85615,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84944,9 +85636,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *543 + default: *546 '404': *6 '500': *69 put: @@ -84964,8 +85656,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -84990,16 +85682,16 @@ paths: - branch - tag - push - enforcement: *237 + enforcement: *240 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *238 - conditions: *235 + items: *241 + conditions: *238 rules: description: An array of rules within the ruleset. type: array - items: *240 + items: *243 examples: default: value: @@ -85027,9 +85719,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *244 examples: - default: *543 + default: *546 '404': *6 '500': *69 delete: @@ -85047,8 +85739,8 @@ paths: category: repos subcategory: rules parameters: - - *280 - - *281 + - *283 + - *284 - name: ruleset_id description: The ID of the ruleset. in: path @@ -85076,20 +85768,20 @@ 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: - - *280 - - *281 - - *243 - - *244 - - *245 + - *283 + - *284 - *246 - - *65 - - *18 - - *17 - - *544 - - *545 - *247 - *248 - *249 + - *65 + - *18 + - *17 + - *547 + - *548 + - *250 + - *251 + - *252 responses: '200': description: Response @@ -85097,7 +85789,7 @@ paths: application/json: schema: type: array - items: &548 + items: &551 type: object properties: number: *70 @@ -85113,8 +85805,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *546 - resolution: *547 + state: *549 + resolution: *550 resolved_at: type: - string @@ -85279,15 +85971,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 responses: '200': description: Response content: application/json: - schema: *548 + schema: *551 examples: default: value: @@ -85335,9 +86027,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 requestBody: required: true content: @@ -85345,8 +86037,8 @@ paths: schema: type: object properties: - state: *546 - resolution: *547 + state: *549 + resolution: *550 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -85365,7 +86057,7 @@ paths: description: Response content: application/json: - schema: *548 + schema: *551 examples: default: value: @@ -85436,9 +86128,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: - - *280 - - *281 - - *367 + - *283 + - *284 + - *370 - *18 - *17 responses: @@ -85449,7 +86141,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &703 + items: &706 type: object properties: type: @@ -85828,8 +86520,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -85837,14 +86529,14 @@ paths: schema: type: object properties: - reason: &550 + reason: &553 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *549 + placeholder_id: *552 required: - reason - placeholder_id @@ -85861,7 +86553,7 @@ paths: schema: type: object properties: - reason: *550 + reason: *553 expire_at: type: - string @@ -85907,8 +86599,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *280 - - *281 + - *283 + - *284 - *65 - name: sort description: The property to sort the results by. @@ -85952,9 +86644,9 @@ paths: application/json: schema: type: array - items: *551 + items: *554 examples: - default: *552 + default: *555 '400': *14 '404': *6 x-github: @@ -85977,8 +86669,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -86058,7 +86750,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 required: - login - type @@ -86148,9 +86840,9 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: &554 + default: &557 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -86383,8 +87075,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -86497,7 +87189,7 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: default: value: @@ -86644,17 +87336,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: '200': description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: *554 + default: *557 '403': *27 '404': *6 x-github: @@ -86678,9 +87370,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 requestBody: required: true content: @@ -86760,7 +87452,7 @@ paths: login: type: string description: The username of the user credited. - type: *252 + type: *255 required: - login - type @@ -86851,17 +87543,17 @@ paths: description: Response content: application/json: - schema: *551 + schema: *554 examples: - default: *554 - add_credit: *554 + default: *557 + add_credit: *557 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *117 + schema: *120 examples: invalid_state_transition: value: @@ -86892,11 +87584,11 @@ 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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: - '202': *120 + '202': *123 '400': *14 '403': *27 '404': *6 @@ -86921,17 +87613,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: - - *280 - - *281 - - *553 + - *283 + - *284 + - *556 responses: '202': description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 '400': *14 '422': *15 '403': *27 @@ -86957,8 +87649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87054,8 +87746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -87064,7 +87756,7 @@ paths: application/json: schema: type: array - items: &555 + items: &558 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -87076,8 +87768,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *120 - '204': *163 + '202': *123 + '204': *166 '422': description: Repository contains more than 10,000 commits x-github: @@ -87097,8 +87789,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87148,8 +87840,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *120 - '204': *163 + '202': *123 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87176,8 +87868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87248,8 +87940,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *120 - '204': *163 + '202': *123 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87271,8 +87963,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -87426,8 +88118,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -87437,7 +88129,7 @@ paths: application/json: schema: type: array - items: *555 + items: *558 examples: default: value: @@ -87450,7 +88142,7 @@ paths: - - 0 - 2 - 21 - '204': *163 + '204': *166 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87470,8 +88162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *280 - - *281 + - *283 + - *284 - name: sha in: path required: true @@ -87527,7 +88219,7 @@ paths: description: Response content: application/json: - schema: *556 + schema: *559 examples: default: value: @@ -87581,8 +88273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87594,7 +88286,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -87614,14 +88306,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &557 + schema: &560 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -87694,8 +88386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: false content: @@ -87721,7 +88413,7 @@ paths: description: Response content: application/json: - schema: *557 + schema: *560 examples: default: value: @@ -87748,8 +88440,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -87769,8 +88461,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -87852,8 +88544,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: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -87861,7 +88553,7 @@ paths: application/json: schema: type: array - items: &558 + items: &561 title: Tag protection description: Tag protection type: object @@ -87918,8 +88610,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: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -87942,7 +88634,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *561 examples: default: value: @@ -87973,8 +88665,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: - - *280 - - *281 + - *283 + - *284 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -88011,8 +88703,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *280 - - *281 + - *283 + - *284 - name: ref in: path required: true @@ -88048,8 +88740,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *280 - - *281 + - *283 + - *284 - *17 - *18 responses: @@ -88059,9 +88751,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *212 + default: *215 headers: Link: *37 '404': *6 @@ -88081,8 +88773,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *280 - - *281 + - *283 + - *284 - *18 - *17 responses: @@ -88090,7 +88782,7 @@ paths: description: Response content: application/json: - schema: &559 + schema: &562 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -88102,7 +88794,7 @@ paths: required: - names examples: - default: &560 + default: &563 value: names: - octocat @@ -88125,8 +88817,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -88157,9 +88849,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *562 examples: - default: *560 + default: *563 '404': *6 '422': *7 x-github: @@ -88180,9 +88872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *280 - - *281 - - &561 + - *283 + - *284 + - &564 name: per description: The time frame to display results for. in: query @@ -88213,7 +88905,7 @@ paths: - 128 clones: type: array - items: &562 + items: &565 title: Traffic type: object properties: @@ -88300,8 +88992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -88395,8 +89087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *280 - - *281 + - *283 + - *284 responses: '200': description: Response @@ -88459,9 +89151,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *280 - - *281 - - *561 + - *283 + - *284 + - *564 responses: '200': description: Response @@ -88482,7 +89174,7 @@ paths: - 3782 views: type: array - items: *562 + items: *565 required: - uniques - count @@ -88559,8 +89251,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *280 - - *281 + - *283 + - *284 requestBody: required: true content: @@ -88596,7 +89288,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *135 examples: default: value: @@ -88834,8 +89526,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -88858,8 +89550,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -88881,8 +89573,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -88908,8 +89600,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *280 - - *281 + - *283 + - *284 - name: ref in: path required: true @@ -89001,9 +89693,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -89044,7 +89736,7 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: default: value: @@ -89157,7 +89849,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &570 + - &573 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -89167,7 +89859,7 @@ paths: type: string examples: - members - - &575 + - &578 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -89179,7 +89871,7 @@ paths: format: int32 examples: - 1 - - &576 + - &579 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -89223,7 +89915,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &564 + items: &567 allOf: - type: object required: @@ -89305,7 +89997,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: &577 + meta: &580 type: object description: The metadata associated with the creation/updates to the user. @@ -89370,31 +90062,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e startIndex: 1 itemsPerPage: 20 - '400': &565 + '400': &568 description: Bad request content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '401': &566 + schema: *566 + '401': &569 description: Authorization failure - '403': &567 + '403': &570 description: Permission denied - '429': &568 + '429': &571 description: Too many requests content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '500': &569 + schema: *566 + '500': &572 description: Internal server error content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 + schema: *566 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89421,7 +90113,7 @@ paths: required: true content: application/json: - schema: &573 + schema: &576 type: object required: - schemas @@ -89481,9 +90173,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *564 + schema: *567 examples: - group: &571 + group: &574 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -89502,13 +90194,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e - '400': *565 - '401': *566 - '403': *567 - '409': &574 + '400': *568 + '401': *569 + '403': *570 + '409': &577 description: Duplicate record detected - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89529,7 +90221,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: - - &572 + - &575 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -89538,22 +90230,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *570 + - *573 - *38 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *564 + schema: *567 examples: - default: *571 - '400': *565 - '401': *566 - '403': *567 + default: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89575,13 +90267,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: - - *572 + - *575 - *38 requestBody: required: true content: application/json: - schema: *573 + schema: *576 examples: group: summary: Group @@ -89607,17 +90299,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *564 + schema: *567 examples: - group: *571 - groupWithMembers: *571 - '400': *565 - '401': *566 - '403': *567 + group: *574 + groupWithMembers: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89644,13 +90336,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: - - *572 + - *575 - *38 requestBody: required: true content: application/json: - schema: &584 + schema: &587 type: object required: - Operations @@ -89710,17 +90402,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *564 + schema: *567 examples: - updateGroup: *571 - addMembers: *571 - '400': *565 - '401': *566 - '403': *567 + updateGroup: *574 + addMembers: *574 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89740,17 +90432,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: - - *572 + - *575 - *38 responses: '204': description: Group was deleted, no content - '400': *565 - '401': *566 - '403': *567 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -89787,8 +90479,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *575 - - *576 + - *578 + - *579 - *38 responses: '200': @@ -89822,7 +90514,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &579 + items: &582 allOf: - type: object required: @@ -89914,7 +90606,7 @@ paths: address. examples: - true - roles: &578 + roles: &581 type: array description: The roles assigned to the user. items: @@ -89973,7 +90665,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *577 + meta: *580 startIndex: type: integer description: A starting index for the returned page @@ -90012,11 +90704,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *565 - '401': *566 - '403': *567 - '429': *568 - '500': *569 + '400': *568 + '401': *569 + '403': *570 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90043,7 +90735,7 @@ paths: required: true content: application/json: - schema: &582 + schema: &585 type: object required: - schemas @@ -90136,9 +90828,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *578 + roles: *581 examples: - user: &583 + user: &586 summary: User value: schemas: @@ -90185,9 +90877,9 @@ paths: description: User has been created content: application/scim+json: - schema: *579 + schema: *582 examples: - user: &580 + user: &583 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90213,13 +90905,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: *580 - '400': *565 - '401': *566 - '403': *567 - '409': *574 - '429': *568 - '500': *569 + enterpriseOwner: *583 + '400': *568 + '401': *569 + '403': *570 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90240,7 +90932,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: - - &581 + - &584 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -90253,15 +90945,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *579 + schema: *582 examples: - default: *580 - '400': *565 - '401': *566 - '403': *567 + default: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90286,30 +90978,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: - - *581 + - *584 - *38 requestBody: required: true content: application/json: - schema: *582 + schema: *585 examples: - user: *583 + user: *586 responses: '200': description: User was updated content: application/scim+json: - schema: *579 + schema: *582 examples: - user: *580 - '400': *565 - '401': *566 - '403': *567 + user: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90347,13 +91039,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: - - *581 + - *584 - *38 requestBody: required: true content: application/json: - schema: *584 + schema: *587 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -90393,18 +91085,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *579 - examples: - userMultiValuedProperties: *580 - userSingleValuedProperties: *580 - disableUser: *580 - '400': *565 - '401': *566 - '403': *567 + schema: *582 + examples: + userMultiValuedProperties: *583 + userSingleValuedProperties: *583 + disableUser: *583 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '409': *574 - '429': *568 - '500': *569 + '409': *577 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90424,17 +91116,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: - - *581 + - *584 - *38 responses: '204': description: User was deleted, no content - '400': *565 - '401': *566 - '403': *567 + '400': *568 + '401': *569 + '403': *570 '404': *6 - '429': *568 - '500': *569 + '429': *571 + '500': *572 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -90467,7 +91159,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *114 + - *117 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -90525,7 +91217,7 @@ paths: - 1 Resources: type: array - items: &585 + items: &588 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -90772,22 +91464,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &586 + '404': &589 description: Resource not found content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '403': &587 + schema: *566 + '403': &590 description: Forbidden content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '400': *565 - '429': *568 + schema: *566 + '400': *568 + '429': *571 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -90807,15 +91499,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *114 + - *117 responses: '201': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: &588 + default: &591 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -90838,17 +91530,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *586 - '403': *587 - '500': *569 + '404': *589 + '403': *590 + '500': *572 '409': description: Conflict content: application/json: - schema: *563 + schema: *566 application/scim+json: - schema: *563 - '400': *565 + schema: *566 + '400': *568 requestBody: required: true content: @@ -90942,18 +91634,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#get-scim-provisioning-information-for-a-user parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 - '404': *586 - '403': *587 + default: *591 + '404': *589 + '403': *590 '304': *35 x-github: githubCloudOnly: true @@ -90976,19 +91668,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 + default: *591 '304': *35 - '404': *586 - '403': *587 + '404': *589 + '403': *590 requestBody: required: true content: @@ -91098,20 +91790,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user parameters: - - *114 - - *581 + - *117 + - *584 responses: '200': description: Response content: application/scim+json: - schema: *585 + schema: *588 examples: - default: *588 + default: *591 '304': *35 - '404': *586 - '403': *587 - '400': *565 + '404': *589 + '403': *590 + '400': *568 '429': description: Response content: @@ -91206,13 +91898,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#delete-a-scim-user-from-an-organization parameters: - - *114 - - *581 + - *117 + - *584 responses: '204': description: Response - '404': *586 - '403': *587 + '404': *589 + '403': *590 '304': *35 x-github: githubCloudOnly: true @@ -91327,7 +92019,7 @@ paths: html_url: type: string format: uri - repository: *132 + repository: *135 score: type: number file_size: @@ -91346,7 +92038,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &589 + text_matches: &592 title: Search Result Text Matches type: array items: @@ -91510,7 +92202,7 @@ paths: enum: - author-date - committer-date - - &590 + - &593 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 @@ -91579,7 +92271,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 comment_count: type: integer message: @@ -91598,7 +92290,7 @@ paths: url: type: string format: uri - verification: *442 + verification: *445 required: - author - committer @@ -91613,7 +92305,7 @@ paths: committer: anyOf: - type: 'null' - - *337 + - *340 parents: type: array items: @@ -91625,12 +92317,12 @@ paths: type: string sha: type: string - repository: *132 + repository: *135 score: type: number node_id: type: string - text_matches: *589 + text_matches: *592 required: - sha - node_id @@ -91823,7 +92515,7 @@ paths: - interactions - created - updated - - *590 + - *593 - *17 - *18 responses: @@ -91925,7 +92617,7 @@ paths: milestone: anyOf: - type: 'null' - - *397 + - *400 comments: type: integer created_at: @@ -91939,7 +92631,7 @@ paths: - string - 'null' format: date-time - text_matches: *589 + text_matches: *592 pull_request: type: object properties: @@ -91977,7 +92669,7 @@ paths: type: string score: type: number - author_association: *85 + author_association: *88 draft: type: boolean repository: *55 @@ -91992,7 +92684,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *86 + reactions: *89 required: - assignee - closed_at @@ -92161,7 +92853,7 @@ paths: enum: - created - updated - - *590 + - *593 - *17 - *18 responses: @@ -92206,7 +92898,7 @@ paths: - 'null' score: type: number - text_matches: *589 + text_matches: *592 required: - id - node_id @@ -92292,7 +92984,7 @@ paths: - forks - help-wanted-issues - updated - - *590 + - *593 - *17 - *18 responses: @@ -92511,7 +93203,7 @@ paths: license: anyOf: - type: 'null' - - *99 + - *102 permissions: type: object properties: @@ -92529,7 +93221,7 @@ paths: - admin - pull - push - text_matches: *589 + text_matches: *592 temp_clone_token: type: string allow_merge_commit: @@ -92838,7 +93530,7 @@ paths: - string - 'null' format: uri - text_matches: *589 + text_matches: *592 related: type: - array @@ -93033,7 +93725,7 @@ paths: - followers - repositories - joined - - *590 + - *593 - *17 - *18 responses: @@ -93143,7 +93835,7 @@ paths: type: - boolean - 'null' - text_matches: *589 + text_matches: *592 blog: type: - string @@ -93225,7 +93917,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &591 + - &594 name: team_id description: The unique identifier of the team. in: path @@ -93237,9 +93929,9 @@ paths: description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 x-github: githubCloudOnly: false @@ -93266,7 +93958,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *591 + - *594 requestBody: required: true content: @@ -93330,16 +94022,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '201': description: Response content: application/json: - schema: *261 + schema: *264 examples: - default: *262 + default: *265 '404': *6 '422': *15 '403': *27 @@ -93367,7 +94059,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *591 + - *594 responses: '204': description: Response @@ -93398,7 +94090,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *591 + - *594 - *65 - *17 - *18 @@ -93409,9 +94101,9 @@ paths: application/json: schema: type: array - items: *263 + items: *266 examples: - default: *592 + default: *595 headers: Link: *37 x-github: @@ -93440,7 +94132,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *591 + - *594 requestBody: required: true content: @@ -93474,9 +94166,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: triggersNotification: true githubCloudOnly: false @@ -93503,16 +94195,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 responses: '200': description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *264 + default: *267 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93537,8 +94229,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 requestBody: required: false content: @@ -93561,9 +94253,9 @@ paths: description: Response content: application/json: - schema: *263 + schema: *266 examples: - default: *593 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93588,8 +94280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *591 - - *265 + - *594 + - *268 responses: '204': description: Response @@ -93618,8 +94310,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *591 - - *265 + - *594 + - *268 - *65 - *17 - *18 @@ -93630,9 +94322,9 @@ paths: application/json: schema: type: array - items: *266 + items: *269 examples: - default: *594 + default: *597 headers: Link: *37 x-github: @@ -93661,8 +94353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 + - *268 requestBody: required: true content: @@ -93684,9 +94376,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: triggersNotification: true githubCloudOnly: false @@ -93713,17 +94405,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 responses: '200': description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *267 + default: *270 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93748,9 +94440,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 requestBody: required: true content: @@ -93772,9 +94464,9 @@ paths: description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *595 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93799,9 +94491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *591 - - *265 + - *594 - *268 + - *271 responses: '204': description: Response @@ -93830,9 +94522,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: - - *591 - - *265 + - *594 - *268 + - *271 - 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. @@ -93858,9 +94550,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -93889,9 +94581,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: - - *591 - - *265 + - *594 - *268 + - *271 requestBody: required: true content: @@ -93923,9 +94615,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93951,8 +94643,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: - - *591 - - *265 + - *594 + - *268 - 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. @@ -93978,9 +94670,9 @@ paths: application/json: schema: type: array - items: *269 + items: *272 examples: - default: *271 + default: *274 headers: Link: *37 x-github: @@ -94009,8 +94701,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: - - *591 - - *265 + - *594 + - *268 requestBody: required: true content: @@ -94042,9 +94734,9 @@ paths: description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94068,7 +94760,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94078,9 +94770,9 @@ paths: application/json: schema: type: array - items: *195 + items: *198 examples: - default: *196 + default: *199 headers: Link: *37 x-github: @@ -94106,7 +94798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *591 + - *594 - name: role description: Filters members returned by their role in the team. in: query @@ -94129,7 +94821,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '404': *6 @@ -94157,8 +94849,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: if user is a member @@ -94194,8 +94886,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94234,8 +94926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94271,16 +94963,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: - - *591 - - *154 + - *594 + - *157 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-user-is-a-team-maintainer: *596 + response-if-user-is-a-team-maintainer: *599 '404': *6 x-github: githubCloudOnly: false @@ -94313,8 +95005,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *591 - - *154 + - *594 + - *157 requestBody: required: false content: @@ -94339,9 +95031,9 @@ paths: description: Response content: application/json: - schema: *277 + schema: *280 examples: - response-if-users-membership-with-team-is-now-pending: *597 + response-if-users-membership-with-team-is-now-pending: *600 '403': description: Forbidden if team synchronization is set up '422': @@ -94375,8 +95067,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *591 - - *154 + - *594 + - *157 responses: '204': description: Response @@ -94405,7 +95097,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94415,9 +95107,9 @@ paths: application/json: schema: type: array - items: *278 + items: *281 examples: - default: *598 + default: *601 headers: Link: *37 '404': *6 @@ -94444,16 +95136,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: - - *591 - - *279 + - *594 + - *282 responses: '200': description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *599 + default: *602 '404': description: Not Found if project is not managed by this team x-github: @@ -94478,8 +95170,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: - - *591 - - *279 + - *594 + - *282 requestBody: required: false content: @@ -94547,8 +95239,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: - - *591 - - *279 + - *594 + - *282 responses: '204': description: Response @@ -94575,7 +95267,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94585,9 +95277,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '404': *6 @@ -94617,15 +95309,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *600 + schema: *603 examples: alternative-response-with-extra-repository-information: value: @@ -94776,9 +95468,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 requestBody: required: false content: @@ -94828,9 +95520,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: - - *591 - - *280 - - *281 + - *594 + - *283 + - *284 responses: '204': description: Response @@ -94859,15 +95551,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: - - *591 + - *594 responses: '200': description: Response content: application/json: - schema: *282 + schema: *285 examples: - default: *283 + default: *286 '403': *27 '404': *6 x-github: @@ -94894,7 +95586,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: - - *591 + - *594 requestBody: required: true content: @@ -94955,7 +95647,7 @@ paths: description: Response content: application/json: - schema: *282 + schema: *285 examples: default: value: @@ -94986,7 +95678,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *591 + - *594 - *17 - *18 responses: @@ -94996,9 +95688,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - response-if-child-teams-exist: *601 + response-if-child-teams-exist: *604 headers: Link: *37 '404': *6 @@ -95031,7 +95723,7 @@ paths: application/json: schema: oneOf: - - &603 + - &606 title: Private User description: Private User type: object @@ -95281,7 +95973,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *602 + - *605 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -95441,7 +96133,7 @@ paths: description: Response content: application/json: - schema: *603 + schema: *606 examples: default: value: @@ -95520,7 +96212,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 '304': *35 '404': *6 '403': *27 @@ -95543,7 +96235,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#check-if-a-user-is-blocked-by-the-authenticated-user parameters: - - *154 + - *157 responses: '204': description: If the user is blocked @@ -95571,7 +96263,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -95595,7 +96287,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -95644,9 +96336,9 @@ paths: type: integer codespaces: type: array - items: *202 + items: *205 examples: - default: *203 + default: *206 '304': *35 '500': *69 '401': *23 @@ -95785,17 +96477,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -95839,7 +96531,7 @@ paths: type: integer secrets: type: array - items: &604 + items: &607 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -95881,7 +96573,7 @@ paths: - visibility - selected_repositories_url examples: - default: *386 + default: *389 headers: Link: *37 x-github: @@ -95953,13 +96645,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: - - *142 + - *145 responses: '200': description: Response content: application/json: - schema: *604 + schema: *607 examples: default: value: @@ -95989,7 +96681,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: - - *142 + - *145 requestBody: required: true content: @@ -96034,7 +96726,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -96062,7 +96754,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: - - *142 + - *145 responses: '204': description: Response @@ -96087,7 +96779,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: - - *142 + - *145 responses: '200': description: Response @@ -96103,9 +96795,9 @@ paths: type: integer repositories: type: array - items: *132 + items: *135 examples: - default: *605 + default: *608 '401': *23 '403': *27 '404': *6 @@ -96130,7 +96822,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: - - *142 + - *145 requestBody: required: true content: @@ -96184,7 +96876,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: - - *142 + - *145 - name: repository_id in: path required: true @@ -96217,7 +96909,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: - - *142 + - *145 - name: repository_id in: path required: true @@ -96249,15 +96941,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '304': *35 '500': *69 '401': *23 @@ -96283,7 +96975,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: - - *204 + - *207 requestBody: required: false content: @@ -96313,9 +97005,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '401': *23 '403': *27 '404': *6 @@ -96337,9 +97029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *204 + - *207 responses: - '202': *120 + '202': *123 '304': *35 '500': *69 '401': *23 @@ -96366,13 +97058,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: - - *204 + - *207 responses: '202': description: Response content: application/json: - schema: &606 + schema: &609 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -96425,7 +97117,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &607 + default: &610 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -96457,7 +97149,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *204 + - *207 - name: export_id in: path required: true @@ -96470,9 +97162,9 @@ paths: description: Response content: application/json: - schema: *606 + schema: *609 examples: - default: *607 + default: *610 '404': *6 x-github: githubCloudOnly: false @@ -96493,7 +97185,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *204 + - *207 responses: '200': description: Response @@ -96509,9 +97201,9 @@ paths: type: integer machines: type: array - items: *385 + items: *388 examples: - default: *608 + default: *611 '304': *35 '500': *69 '401': *23 @@ -96540,7 +97232,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: - - *204 + - *207 requestBody: required: true content: @@ -96596,11 +97288,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *293 + repository: *296 machine: anyOf: - type: 'null' - - *385 + - *388 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -97397,15 +98089,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '304': *35 '500': *69 '400': *14 @@ -97417,7 +98109,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *119 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97437,15 +98129,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: - - *204 + - *207 responses: '200': description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *384 + default: *387 '500': *69 '401': *23 '403': *27 @@ -97475,9 +98167,9 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: &621 + default: &624 value: - id: 197 name: hello_docker @@ -97578,7 +98270,7 @@ paths: application/json: schema: type: array - items: &609 + items: &612 title: Email description: Email type: object @@ -97648,9 +98340,9 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: - default: &623 + default: &626 value: - email: octocat@github.com verified: true @@ -97727,7 +98419,7 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: default: value: @@ -97839,7 +98531,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '304': *35 @@ -97872,7 +98564,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 '304': *35 @@ -97894,7 +98586,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-user parameters: - - *154 + - *157 responses: '204': description: if the person is followed by the authenticated user @@ -97924,7 +98616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -97948,7 +98640,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *154 + - *157 responses: '204': description: Response @@ -97984,7 +98676,7 @@ paths: application/json: schema: type: array - items: &610 + items: &613 title: GPG Key description: A unique encryption key type: object @@ -98129,7 +98821,7 @@ paths: - subkeys - revoked examples: - default: &634 + default: &637 value: - id: 3 name: Octocat's GPG Key @@ -98214,9 +98906,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *613 examples: - default: &611 + default: &614 value: id: 3 name: Octocat's GPG Key @@ -98273,7 +98965,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: - - &612 + - &615 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -98285,9 +98977,9 @@ paths: description: Response content: application/json: - schema: *610 + schema: *613 examples: - default: *611 + default: *614 '404': *6 '304': *35 '403': *27 @@ -98310,7 +99002,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: - - *612 + - *615 responses: '204': description: Response @@ -98501,7 +99193,7 @@ paths: type: array items: *55 examples: - default: *613 + default: *616 headers: Link: *37 '404': *6 @@ -98526,7 +99218,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *127 + - *130 responses: '204': description: Response @@ -98552,7 +99244,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *127 + - *130 responses: '204': description: Response @@ -98586,12 +99278,12 @@ paths: application/json: schema: anyOf: - - *193 + - *196 - type: object properties: {} additionalProperties: false examples: - default: *194 + default: *197 '204': description: Response when there are no restrictions x-github: @@ -98615,7 +99307,7 @@ paths: required: true content: application/json: - schema: *453 + schema: *456 examples: default: value: @@ -98626,7 +99318,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -98707,7 +99399,7 @@ paths: - closed - all default: open - - *199 + - *202 - name: sort description: What to sort results by. in: query @@ -98720,7 +99412,7 @@ paths: - comments default: created - *65 - - *88 + - *91 - *17 - *18 responses: @@ -98730,9 +99422,9 @@ paths: application/json: schema: type: array - items: *98 + items: *101 examples: - default: *200 + default: *203 headers: Link: *37 '404': *6 @@ -98765,7 +99457,7 @@ paths: application/json: schema: type: array - items: &614 + items: &617 title: Key description: Key type: object @@ -98863,9 +99555,9 @@ paths: description: Response content: application/json: - schema: *614 + schema: *617 examples: - default: &615 + default: &618 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -98898,15 +99590,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: - - *479 + - *482 responses: '200': description: Response content: application/json: - schema: *614 + schema: *617 examples: - default: *615 + default: *618 '404': *6 '304': *35 '403': *27 @@ -98929,7 +99621,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: - - *479 + - *482 responses: '204': description: Response @@ -98962,7 +99654,7 @@ paths: application/json: schema: type: array - items: &616 + items: &619 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -99030,7 +99722,7 @@ paths: - id - type - login - plan: *101 + plan: *104 required: - billing_cycle - next_billing_date @@ -99041,7 +99733,7 @@ paths: - account - plan examples: - default: &617 + default: &620 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -99103,9 +99795,9 @@ paths: application/json: schema: type: array - items: *616 + items: *619 examples: - default: *617 + default: *620 headers: Link: *37 '304': *35 @@ -99145,7 +99837,7 @@ paths: application/json: schema: type: array - items: *205 + items: *208 examples: default: value: @@ -99247,13 +99939,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *114 + - *117 responses: '200': description: Response content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -99311,7 +100003,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *114 + - *117 requestBody: required: true content: @@ -99336,7 +100028,7 @@ paths: description: Response content: application/json: - schema: *205 + schema: *208 examples: default: value: @@ -99404,7 +100096,7 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: default: value: @@ -99666,7 +100358,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -99846,7 +100538,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *208 + - *211 - name: exclude in: query required: false @@ -99859,7 +100551,7 @@ paths: description: Response content: application/json: - schema: *207 + schema: *210 examples: default: value: @@ -100053,7 +100745,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *208 + - *211 responses: '302': description: Response @@ -100079,7 +100771,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *208 + - *211 responses: '204': description: Response @@ -100108,8 +100800,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *208 - - *618 + - *211 + - *621 responses: '204': description: Response @@ -100133,7 +100825,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *208 + - *211 - *17 - *18 responses: @@ -100143,9 +100835,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '404': *6 @@ -100182,7 +100874,7 @@ paths: type: array items: *50 examples: - default: *619 + default: *622 headers: Link: *37 '304': *35 @@ -100224,7 +100916,7 @@ paths: - docker - nuget - container - - *620 + - *623 - *18 - *17 responses: @@ -100234,10 +100926,10 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 - '400': *622 + default: *624 + '400': *625 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100257,16 +100949,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: - - *215 - - *216 + - *218 + - *219 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: - default: &635 + default: &638 value: id: 40201 name: octo-name @@ -100379,8 +101071,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: - - *215 - - *216 + - *218 + - *219 responses: '204': description: Response @@ -100410,8 +101102,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: - - *215 - - *216 + - *218 + - *219 - name: token description: package token schema: @@ -100443,8 +101135,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: - - *215 - - *216 + - *218 + - *219 - *18 - *17 - name: state @@ -100464,7 +101156,7 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: default: value: @@ -100513,15 +101205,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -100557,9 +101249,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '204': description: Response @@ -100589,9 +101281,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: - - *215 - - *216 - *218 + - *219 + - *221 responses: '204': description: Response @@ -100649,7 +101341,7 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: default: value: @@ -100718,9 +101410,9 @@ paths: application/json: schema: type: array - items: *609 + items: *612 examples: - default: *623 + default: *626 headers: Link: *37 '304': *35 @@ -100833,7 +101525,7 @@ paths: type: array items: *55 examples: - default: &630 + default: &633 summary: Default response value: - id: 1296269 @@ -101149,9 +101841,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *296 examples: - default: *295 + default: *298 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -101189,9 +101881,9 @@ paths: application/json: schema: type: array - items: *455 + items: *458 examples: - default: *624 + default: *627 headers: Link: *37 '304': *35 @@ -101214,12 +101906,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *197 + - *200 responses: '204': description: Response '403': *27 - '409': *119 + '409': *122 '404': *6 '304': *35 x-github: @@ -101237,11 +101929,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *197 + - *200 responses: '204': description: Response - '409': *119 + '409': *122 '304': *35 '404': *6 '403': *27 @@ -101270,7 +101962,7 @@ paths: application/json: schema: type: array - items: &625 + items: &628 title: Social account description: Social media account type: object @@ -101287,7 +101979,7 @@ paths: - provider - url examples: - default: &626 + default: &629 value: - provider: twitter url: https://twitter.com/github @@ -101350,9 +102042,9 @@ paths: application/json: schema: type: array - items: *625 + items: *628 examples: - default: *626 + default: *629 '422': *15 '304': *35 '404': *6 @@ -101440,7 +102132,7 @@ paths: application/json: schema: type: array - items: &627 + items: &630 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -101460,7 +102152,7 @@ paths: - title - created_at examples: - default: &636 + default: &639 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101527,9 +102219,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *630 examples: - default: &628 + default: &631 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101560,7 +102252,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: - - &629 + - &632 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -101572,9 +102264,9 @@ paths: description: Response content: application/json: - schema: *627 + schema: *630 examples: - default: *628 + default: *631 '404': *6 '304': *35 '403': *27 @@ -101597,7 +102289,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: - - *629 + - *632 responses: '204': description: Response @@ -101626,7 +102318,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: - - &637 + - &640 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 @@ -101651,11 +102343,11 @@ paths: type: array items: *55 examples: - default-response: *630 + default-response: *633 application/vnd.github.v3.star+json: schema: type: array - items: &638 + items: &641 title: Starred Repository description: Starred Repository type: object @@ -101811,8 +102503,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response if this repository is starred by you @@ -101840,8 +102532,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -101865,8 +102557,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: - - *280 - - *281 + - *283 + - *284 responses: '204': description: Response @@ -101899,9 +102591,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 '304': *35 @@ -101938,7 +102630,7 @@ paths: application/json: schema: type: array - items: *261 + items: *264 examples: default: value: @@ -102014,7 +102706,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *103 + - *106 responses: '200': description: Response @@ -102022,10 +102714,10 @@ paths: application/json: schema: oneOf: - - *603 - - *602 + - *606 + - *605 examples: - default-response: &632 + default-response: &635 summary: Default response value: login: octocat @@ -102060,7 +102752,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &633 + response-with-git-hub-plan-information: &636 summary: Response with GitHub plan information value: login: octocat @@ -102120,7 +102812,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *631 + - *634 - *17 responses: '200': @@ -102131,7 +102823,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: example: ; rel="next" @@ -102159,7 +102851,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *154 + - *157 responses: '200': description: Response @@ -102167,11 +102859,11 @@ paths: application/json: schema: oneOf: - - *603 - - *602 + - *606 + - *605 examples: - default-response: *632 - response-with-git-hub-plan-information: *633 + default-response: *635 + response-with-git-hub-plan-information: *636 '404': *6 x-github: githubCloudOnly: false @@ -102197,7 +102889,7 @@ paths: - *17 - *63 - *64 - - *154 + - *157 - name: subject_digest description: Subject Digest in: path @@ -102299,7 +102991,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *146 examples: default: value: @@ -102325,7 +103017,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user parameters: - - *154 + - *157 responses: '200': description: Response @@ -102333,9 +103025,9 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 + default: *624 '403': *27 '401': *23 x-github: @@ -102358,7 +103050,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102368,7 +103060,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102439,8 +103131,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *154 - - *114 + - *157 + - *117 - *17 - *18 responses: @@ -102450,7 +103142,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102529,7 +103221,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102539,7 +103231,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -102606,7 +103298,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102618,7 +103310,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -102637,7 +103329,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102649,7 +103341,7 @@ paths: type: array items: *4 examples: - default: *201 + default: *204 headers: Link: *37 x-github: @@ -102668,7 +103360,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#check-if-a-user-follows-another-user parameters: - - *154 + - *157 - name: target_user in: path required: true @@ -102695,8 +103387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *154 - - *88 + - *157 + - *91 - *17 - *18 responses: @@ -102706,9 +103398,9 @@ paths: application/json: schema: type: array - items: *89 + items: *92 examples: - default: *90 + default: *93 headers: Link: *37 '422': *15 @@ -102729,7 +103421,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102739,9 +103431,9 @@ paths: application/json: schema: type: array - items: *610 + items: *613 examples: - default: *634 + default: *637 headers: Link: *37 x-github: @@ -102765,7 +103457,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *154 + - *157 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -102837,7 +103529,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *154 + - *157 responses: '200': description: Response @@ -102845,7 +103537,7 @@ paths: application/json: schema: *20 examples: - default: *452 + default: *455 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102863,7 +103555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102911,7 +103603,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -102923,7 +103615,7 @@ paths: type: array items: *50 examples: - default: *619 + default: *622 headers: Link: *37 x-github: @@ -102962,8 +103654,8 @@ paths: - docker - nuget - container - - *620 - - *154 + - *623 + - *157 - *18 - *17 responses: @@ -102973,12 +103665,12 @@ paths: application/json: schema: type: array - items: *213 + items: *216 examples: - default: *621 + default: *624 '403': *27 '401': *23 - '400': *622 + '400': *625 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102998,17 +103690,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '200': description: Response content: application/json: - schema: *213 + schema: *216 examples: - default: *635 + default: *638 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103029,9 +103721,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '204': description: Response @@ -103063,9 +103755,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 - name: token description: package token schema: @@ -103097,9 +103789,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#list-package-versions-for-a-package-owned-by-a-user parameters: - - *215 - - *216 - - *154 + - *218 + - *219 + - *157 responses: '200': description: Response @@ -103107,7 +103799,7 @@ paths: application/json: schema: type: array - items: *217 + items: *220 examples: default: value: @@ -103165,16 +103857,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: - - *215 - - *216 - *218 - - *154 + - *219 + - *221 + - *157 responses: '200': description: Response content: application/json: - schema: *217 + schema: *220 examples: default: value: @@ -103209,10 +103901,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *215 - - *216 - - *154 - *218 + - *219 + - *157 + - *221 responses: '204': description: Response @@ -103244,10 +103936,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *215 - - *216 - - *154 - *218 + - *219 + - *157 + - *221 responses: '204': description: Response @@ -103270,7 +103962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *154 + - *157 - name: state description: Indicates the state of the projects to return. in: query @@ -103291,7 +103983,7 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: default: value: @@ -103350,7 +104042,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103360,7 +104052,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -103439,7 +104131,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-received-by-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103449,7 +104141,7 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: default: value: @@ -103526,7 +104218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *154 + - *157 - name: type description: Limit results to repositories of the specified type. in: query @@ -103569,9 +104261,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -103595,15 +104287,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103625,15 +104317,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *257 + schema: *260 examples: - default: *258 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103655,15 +104347,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *154 + - *157 responses: '200': description: Response content: application/json: - schema: *259 + schema: *262 examples: - default: *260 + default: *263 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -103681,7 +104373,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103691,9 +104383,9 @@ paths: application/json: schema: type: array - items: *625 + items: *628 examples: - default: *626 + default: *629 headers: Link: *37 x-github: @@ -103713,7 +104405,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103723,9 +104415,9 @@ paths: application/json: schema: type: array - items: *627 + items: *630 examples: - default: *636 + default: *639 headers: Link: *37 x-github: @@ -103749,8 +104441,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *154 - - *637 + - *157 + - *640 - *65 - *17 - *18 @@ -103762,11 +104454,11 @@ paths: schema: anyOf: - type: array - items: *638 + items: *641 - type: array items: *55 examples: - default-response: *630 + default-response: *633 headers: Link: *37 x-github: @@ -103785,7 +104477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *154 + - *157 - *17 - *18 responses: @@ -103795,9 +104487,9 @@ paths: application/json: schema: type: array - items: *132 + items: *135 examples: - default: *219 + default: *222 headers: Link: *37 x-github: @@ -103926,7 +104618,7 @@ webhooks: type: string enum: - disabled - enterprise: &639 + enterprise: &642 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -103995,7 +104687,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &640 + installation: &643 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -104016,7 +104708,7 @@ webhooks: required: - id - node_id - organization: &641 + organization: &644 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -104089,7 +104781,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &642 + repository: &645 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -104118,7 +104810,7 @@ webhooks: license: anyOf: - type: 'null' - - *99 + - *102 organization: anyOf: - type: 'null' @@ -105002,10 +105694,10 @@ webhooks: type: string enum: - enabled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -105081,11 +105773,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: &643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: &646 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) @@ -105308,11 +106000,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: *643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: *646 sender: *4 required: - action @@ -105500,11 +106192,11 @@ webhooks: - everyone required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - rule: *643 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + rule: *646 sender: *4 required: - action @@ -105577,7 +106269,7 @@ webhooks: required: true content: application/json: - schema: &646 + schema: &649 title: Exemption request cancellation event type: object properties: @@ -105585,11 +106277,11 @@ webhooks: type: string enum: - cancelled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: &644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: &647 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -105729,7 +106421,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &645 + items: &648 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -105835,7 +106527,7 @@ webhooks: required: true content: application/json: - schema: &647 + schema: &650 title: Exemption request completed event type: object properties: @@ -105843,11 +106535,11 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 sender: *4 required: - action @@ -105919,7 +106611,7 @@ webhooks: required: true content: application/json: - schema: &648 + schema: &651 title: Exemption request created event type: object properties: @@ -105927,11 +106619,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 sender: *4 required: - action @@ -106003,7 +106695,7 @@ webhooks: required: true content: application/json: - schema: &649 + schema: &652 title: Exemption response dismissed event type: object properties: @@ -106011,12 +106703,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 - exemption_response: *645 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 + exemption_response: *648 sender: *4 required: - action @@ -106090,7 +106782,7 @@ webhooks: required: true content: application/json: - schema: &650 + schema: &653 title: Exemption response submitted event type: object properties: @@ -106098,12 +106790,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - exemption_request: *644 - exemption_response: *645 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + exemption_request: *647 + exemption_response: *648 sender: *4 required: - action @@ -106176,7 +106868,7 @@ webhooks: required: true content: application/json: - schema: *646 + schema: *649 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106243,7 +106935,7 @@ webhooks: required: true content: application/json: - schema: *647 + schema: *650 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106310,7 +107002,7 @@ webhooks: required: true content: application/json: - schema: *648 + schema: *651 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106377,7 +107069,7 @@ webhooks: required: true content: application/json: - schema: *649 + schema: *652 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106445,7 +107137,7 @@ webhooks: required: true content: application/json: - schema: *650 + schema: *653 responses: '200': description: Return a 200 status to indicate that the data was received @@ -106523,7 +107215,7 @@ webhooks: type: string enum: - completed - check_run: &652 + check_run: &655 title: CheckRun description: A check performed on the code of a given code change type: object @@ -106591,8 +107283,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *350 - repository: *132 + items: *353 + repository: *135 status: type: string enum: @@ -106636,7 +107328,7 @@ webhooks: - examples: - neutral - deployment: *651 + deployment: *654 details_url: type: string examples: @@ -106696,7 +107388,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *350 + items: *353 started_at: type: string format: date-time @@ -106734,9 +107426,9 @@ webhooks: - output - app - pull_requests - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -107129,10 +107821,10 @@ webhooks: type: string enum: - created - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -107528,10 +108220,10 @@ webhooks: type: string enum: - requested_action - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 requested_action: description: The action requested by the user. type: object @@ -107936,10 +108628,10 @@ webhooks: type: string enum: - rerequested - check_run: *652 - installation: *640 - organization: *641 - repository: *642 + check_run: *655 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - check_run @@ -108931,10 +109623,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -109619,10 +110311,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -110301,10 +110993,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -110611,20 +111303,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &653 + commit_oid: &656 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: *639 - installation: *640 - organization: *641 - ref: &654 + enterprise: *642 + installation: *643 + organization: *644 + ref: &657 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: *642 + repository: *645 sender: *4 required: - action @@ -110952,12 +111644,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111055,7 +111747,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *362 + dismissed_comment: *365 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -111230,12 +111922,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111567,12 +112259,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -111841,9 +112533,9 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -111851,7 +112543,7 @@ webhooks: type: - string - 'null' - repository: *642 + repository: *645 sender: *4 required: - action @@ -112083,12 +112775,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *653 - enterprise: *639 - installation: *640 - organization: *641 - ref: *654 - repository: *642 + commit_oid: *656 + enterprise: *642 + installation: *643 + organization: *644 + ref: *657 + repository: *645 sender: *4 required: - action @@ -112350,10 +113042,10 @@ webhooks: - updated_at - author_association - body - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -112434,18 +113126,18 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *641 - pusher_type: &655 + organization: *644 + pusher_type: &658 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &656 + ref: &659 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -112455,7 +113147,7 @@ webhooks: enum: - tag - branch - repository: *642 + repository: *645 sender: *4 required: - ref @@ -112537,10 +113229,10 @@ webhooks: type: string enum: - created - definition: *227 - enterprise: *639 - installation: *640 - organization: *641 + definition: *230 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112624,9 +113316,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112702,10 +113394,10 @@ webhooks: type: string enum: - updated - definition: *227 - enterprise: *639 - installation: *640 - organization: *641 + definition: *230 + enterprise: *642 + installation: *643 + organization: *644 sender: *4 required: - action @@ -112781,19 +113473,19 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - repository: *642 - organization: *641 + enterprise: *642 + installation: *643 + repository: *645 + organization: *644 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *231 + items: *234 old_property_values: type: array description: The old custom property values for the repository. - items: *231 + items: *234 required: - action - repository @@ -112869,18 +113561,18 @@ webhooks: title: delete event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - pusher_type: *655 - ref: *656 + enterprise: *642 + installation: *643 + organization: *644 + pusher_type: *658 + ref: *659 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *642 + repository: *645 sender: *4 required: - ref @@ -112964,11 +113656,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113052,11 +113744,11 @@ webhooks: type: string enum: - auto_reopened - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113140,11 +113832,11 @@ webhooks: type: string enum: - created - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113226,11 +113918,11 @@ webhooks: type: string enum: - dismissed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113312,11 +114004,11 @@ webhooks: type: string enum: - fixed - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113399,11 +114091,11 @@ webhooks: type: string enum: - reintroduced - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113485,11 +114177,11 @@ webhooks: type: string enum: - reopened - alert: *411 - installation: *640 - organization: *641 - enterprise: *639 - repository: *642 + alert: *414 + installation: *643 + organization: *644 + enterprise: *642 + repository: *645 sender: *4 required: - action @@ -113566,9 +114258,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - key: &657 + enterprise: *642 + installation: *643 + key: &660 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -113604,8 +114296,8 @@ webhooks: - verified - created_at - read_only - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -113682,11 +114374,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - key: *657 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + key: *660 + organization: *644 + repository: *645 sender: *4 required: - action @@ -114258,12 +114950,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: &661 + workflow: &664 title: Workflow type: - object @@ -115001,13 +115693,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *417 + deployment: *420 pull_requests: type: array - items: *498 - repository: *642 - organization: *641 - installation: *640 + items: *501 + repository: *645 + organization: *644 + installation: *643 sender: *4 responses: '200': @@ -115078,7 +115770,7 @@ webhooks: type: string enum: - approved - approver: &658 + approver: &661 type: object properties: avatar_url: @@ -115121,11 +115813,11 @@ webhooks: type: string comment: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - reviewers: &659 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + reviewers: &662 type: array items: type: object @@ -115206,7 +115898,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &660 + workflow_job_run: &663 type: object properties: conclusion: @@ -115952,18 +116644,18 @@ webhooks: type: string enum: - rejected - approver: *658 + approver: *661 comment: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - reviewers: *659 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + reviewers: *662 sender: *4 since: type: string - workflow_job_run: *660 + workflow_job_run: *663 workflow_job_runs: type: array items: @@ -116680,13 +117372,13 @@ webhooks: type: string enum: - requested - enterprise: *639 + enterprise: *642 environment: type: string - installation: *640 - organization: *641 - repository: *642 - requestor: &666 + installation: *643 + organization: *644 + repository: *645 + requestor: &669 title: User type: - object @@ -118629,12 +119321,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Deployment Workflow Run type: @@ -119325,7 +120017,7 @@ webhooks: type: string enum: - answered - answer: &664 + answer: &667 type: object properties: author_association: @@ -119485,7 +120177,7 @@ webhooks: - created_at - updated_at - body - discussion: &662 + discussion: &665 title: Discussion description: A Discussion in a repository. type: object @@ -119781,7 +120473,7 @@ webhooks: - id labels: type: array - items: *462 + items: *465 required: - repository_url - category @@ -119803,10 +120495,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -119933,11 +120625,11 @@ webhooks: - from required: - category - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120020,11 +120712,11 @@ webhooks: type: string enum: - closed - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120106,7 +120798,7 @@ webhooks: type: string enum: - created - comment: &663 + comment: &666 type: object properties: author_association: @@ -120266,11 +120958,11 @@ webhooks: - updated_at - body - reactions - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120353,12 +121045,12 @@ webhooks: type: string enum: - deleted - comment: *663 - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + comment: *666 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120453,12 +121145,12 @@ webhooks: - from required: - body - comment: *663 - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + comment: *666 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120542,11 +121234,11 @@ webhooks: type: string enum: - created - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120628,11 +121320,11 @@ webhooks: type: string enum: - deleted - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120732,11 +121424,11 @@ webhooks: type: string required: - from - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120818,10 +121510,10 @@ webhooks: type: string enum: - labeled - discussion: *662 - enterprise: *639 - installation: *640 - label: &665 + discussion: *665 + enterprise: *642 + installation: *643 + label: &668 title: Label type: object properties: @@ -120854,8 +121546,8 @@ webhooks: - color - default - description - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -120938,11 +121630,11 @@ webhooks: type: string enum: - locked - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121024,11 +121716,11 @@ webhooks: type: string enum: - pinned - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121110,11 +121802,11 @@ webhooks: type: string enum: - reopened - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121199,16 +121891,16 @@ webhooks: changes: type: object properties: - new_discussion: *662 - new_repository: *642 + new_discussion: *665 + new_repository: *645 required: - new_discussion - new_repository - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121291,10 +121983,10 @@ webhooks: type: string enum: - unanswered - discussion: *662 - old_answer: *664 - organization: *641 - repository: *642 + discussion: *665 + old_answer: *667 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121376,12 +122068,12 @@ webhooks: type: string enum: - unlabeled - discussion: *662 - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121464,11 +122156,11 @@ webhooks: type: string enum: - unlocked - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121550,11 +122242,11 @@ webhooks: type: string enum: - unpinned - discussion: *662 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + discussion: *665 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -121627,7 +122319,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *639 + enterprise: *642 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -122305,9 +122997,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - forkee @@ -122453,9 +123145,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pages: description: The pages that were updated. type: array @@ -122493,7 +123185,7 @@ webhooks: - action - sha - html_url - repository: *642 + repository: *645 sender: *4 required: - pages @@ -122569,10 +123261,10 @@ webhooks: type: string enum: - created - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: &667 + organization: *644 + repositories: &670 description: An array of repository objects that the installation can access. type: array @@ -122598,8 +123290,8 @@ webhooks: - name - full_name - private - repository: *642 - requester: *666 + repository: *645 + requester: *669 sender: *4 required: - action @@ -122674,11 +123366,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -122755,11 +123447,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -122836,10 +123528,10 @@ webhooks: type: string enum: - added - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories_added: &668 + organization: *644 + repositories_added: &671 description: An array of repository objects, which were added to the installation. type: array @@ -122885,15 +123577,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *642 - repository_selection: &669 + repository: *645 + repository_selection: &672 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *666 + requester: *669 sender: *4 required: - action @@ -122972,10 +123664,10 @@ webhooks: type: string enum: - removed - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories_added: *668 + organization: *644 + repositories_added: *671 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -123002,9 +123694,9 @@ webhooks: - name - full_name - private - repository: *642 - repository_selection: *669 - requester: *666 + repository: *645 + repository_selection: *672 + requester: *669 sender: *4 required: - action @@ -123083,11 +123775,11 @@ webhooks: type: string enum: - suspend - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -123270,10 +123962,10 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 target_type: type: string @@ -123352,11 +124044,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *639 + enterprise: *642 installation: *20 - organization: *641 - repositories: *667 - repository: *642 + organization: *644 + repositories: *670 + repository: *645 requester: type: - 'null' @@ -123604,8 +124296,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124781,8 +125473,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -124862,7 +125554,7 @@ webhooks: type: string enum: - deleted - comment: &670 + comment: &673 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -125029,8 +125721,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -126204,8 +126896,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -126285,7 +126977,7 @@ webhooks: type: string enum: - edited - changes: &695 + changes: &698 description: The changes to the comment. type: object properties: @@ -126297,9 +126989,9 @@ webhooks: type: string required: - from - comment: *670 - enterprise: *639 - installation: *640 + comment: *673 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127474,8 +128166,8 @@ webhooks: - state - locked - assignee - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -127557,10 +128249,10 @@ webhooks: type: string enum: - assigned - assignee: *666 - enterprise: *639 - installation: *640 - issue: &673 + assignee: *669 + enterprise: *642 + installation: *643 + issue: &676 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -128490,8 +129182,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -128571,8 +129263,8 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -129650,8 +130342,8 @@ webhooks: required: - state - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -129730,8 +130422,8 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130654,8 +131346,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -130734,8 +131426,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131662,7 +132354,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &671 + milestone: &674 title: Milestone description: A collection of related issues and pull requests. type: object @@ -131805,8 +132497,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -131905,8 +132597,8 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132836,9 +133528,9 @@ webhooks: - active_lock_reason - body - reactions - label: *665 - organization: *641 - repository: *642 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -132918,8 +133610,8 @@ webhooks: type: string enum: - labeled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133848,9 +134540,9 @@ webhooks: - active_lock_reason - body - reactions - label: *665 - organization: *641 - repository: *642 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -133930,8 +134622,8 @@ webhooks: type: string enum: - locked - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134862,8 +135554,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -134942,8 +135634,8 @@ webhooks: type: string enum: - milestoned - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135868,9 +136560,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *671 - organization: *641 - repository: *642 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -137356,8 +138048,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138286,8 +138978,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -138367,9 +139059,9 @@ webhooks: type: string enum: - pinned - enterprise: *639 - installation: *640 - issue: &672 + enterprise: *642 + installation: *643 + issue: &675 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -139292,8 +139984,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -139372,8 +140064,8 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -140303,8 +140995,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -141790,11 +142482,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *639 - installation: *640 - issue: *672 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *675 + organization: *644 + repository: *645 sender: *4 required: - action @@ -141875,7 +142567,7 @@ webhooks: type: string enum: - unassigned - assignee: &698 + assignee: &701 title: User type: - object @@ -141947,11 +142639,11 @@ webhooks: required: - login - id - enterprise: *639 - installation: *640 - issue: *673 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *676 + organization: *644 + repository: *645 sender: *4 required: - action @@ -142030,12 +142722,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *639 - installation: *640 - issue: *673 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *676 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -142115,8 +142807,8 @@ webhooks: type: string enum: - unlocked - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143045,8 +143737,8 @@ webhooks: format: uri user_view_type: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143126,11 +143818,11 @@ webhooks: type: string enum: - unpinned - enterprise: *639 - installation: *640 - issue: *672 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + issue: *675 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143209,11 +143901,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143291,11 +143983,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143405,11 +144097,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - label: *665 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + label: *668 + organization: *644 + repository: *645 sender: *4 required: - action @@ -143491,9 +144183,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: &674 + enterprise: *642 + installation: *643 + marketplace_purchase: &677 title: Marketplace Purchase type: object required: @@ -143581,8 +144273,8 @@ webhooks: type: integer unit_count: type: integer - organization: *641 - previous_marketplace_purchase: &675 + organization: *644 + previous_marketplace_purchase: &678 title: Marketplace Purchase type: object properties: @@ -143666,7 +144358,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -143746,10 +144438,10 @@ webhooks: - changed effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -143837,7 +144529,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -143919,10 +144611,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -144008,7 +144700,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *642 + repository: *645 sender: *4 required: - action @@ -144089,8 +144781,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 marketplace_purchase: title: Marketplace Purchase type: object @@ -144176,9 +144868,9 @@ webhooks: type: integer unit_count: type: integer - organization: *641 - previous_marketplace_purchase: *675 - repository: *642 + organization: *644 + previous_marketplace_purchase: *678 + repository: *645 sender: *4 required: - action @@ -144258,12 +144950,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *639 - installation: *640 - marketplace_purchase: *674 - organization: *641 - previous_marketplace_purchase: *675 - repository: *642 + enterprise: *642 + installation: *643 + marketplace_purchase: *677 + organization: *644 + previous_marketplace_purchase: *678 + repository: *645 sender: *4 required: - action @@ -144365,11 +145057,11 @@ webhooks: type: string required: - to - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144471,11 +145163,11 @@ webhooks: type: - string - 'null' - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144554,11 +145246,11 @@ webhooks: type: string enum: - removed - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 sender: *4 required: - action @@ -144636,11 +145328,11 @@ webhooks: type: string enum: - added - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144718,7 +145410,7 @@ webhooks: required: - login - id - team: &676 + team: &679 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -144911,11 +145603,11 @@ webhooks: type: string enum: - removed - enterprise: *639 - installation: *640 - member: *666 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + member: *669 + organization: *644 + repository: *645 scope: description: The scope of the membership. Currently, can only be `team`. @@ -144994,7 +145686,7 @@ webhooks: required: - login - id - team: *676 + team: *679 required: - action - scope @@ -145076,8 +145768,8 @@ webhooks: type: string enum: - checks_requested - installation: *640 - merge_group: &677 + installation: *643 + merge_group: &680 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -145096,15 +145788,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *354 + head_commit: *357 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145190,10 +145882,10 @@ webhooks: - merged - invalidated - dequeued - installation: *640 - merge_group: *677 - organization: *641 - repository: *642 + installation: *643 + merge_group: *680 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145266,7 +145958,7 @@ webhooks: type: string enum: - deleted - enterprise: *639 + enterprise: *642 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -145374,12 +146066,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *640 - organization: *641 + installation: *643 + organization: *644 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -145459,11 +146151,11 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145542,9 +146234,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - milestone: &678 + enterprise: *642 + installation: *643 + milestone: &681 title: Milestone description: A collection of related issues and pull requests. type: object @@ -145686,8 +146378,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145766,11 +146458,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145880,11 +146572,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - milestone: *671 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *674 + organization: *644 + repository: *645 sender: *4 required: - action @@ -145964,11 +146656,11 @@ webhooks: type: string enum: - opened - enterprise: *639 - installation: *640 - milestone: *678 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + milestone: *681 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146047,11 +146739,11 @@ webhooks: type: string enum: - blocked - blocked_user: *666 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + blocked_user: *669 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146130,11 +146822,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *666 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + blocked_user: *669 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146213,9 +146905,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - membership: &679 + enterprise: *642 + installation: *643 + membership: &682 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -146309,8 +147001,8 @@ webhooks: - role - organization_url - user - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146388,11 +147080,11 @@ webhooks: type: string enum: - member_added - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146471,8 +147163,8 @@ webhooks: type: string enum: - member_invited - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -146594,10 +147286,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 - user: *666 + user: *669 required: - action - invitation @@ -146675,11 +147367,11 @@ webhooks: type: string enum: - member_removed - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146766,11 +147458,11 @@ webhooks: properties: from: type: string - enterprise: *639 - installation: *640 - membership: *679 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + membership: *682 + organization: *644 + repository: *645 sender: *4 required: - action @@ -146846,9 +147538,9 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 package: description: Information about the package. type: object @@ -147371,7 +148063,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &680 + items: &683 title: Ruby Gems metadata type: object properties: @@ -147468,7 +148160,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -147544,9 +148236,9 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 package: description: Information about the package. type: object @@ -147908,7 +148600,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *680 + items: *683 source_url: type: string format: uri @@ -147979,7 +148671,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -148160,12 +148852,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *639 + enterprise: *642 id: type: integer - installation: *640 - organization: *641 - repository: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - id @@ -148245,7 +148937,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &681 + personal_access_token_request: &684 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -148383,10 +149075,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *639 - organization: *641 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148465,11 +149157,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *681 - enterprise: *639 - organization: *641 + personal_access_token_request: *684 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148547,11 +149239,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *681 - enterprise: *639 - organization: *641 + personal_access_token_request: *684 + enterprise: *642 + organization: *644 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148628,11 +149320,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *681 - organization: *641 - enterprise: *639 + personal_access_token_request: *684 + organization: *644 + enterprise: *642 sender: *4 - installation: *640 + installation: *643 required: - action - personal_access_token_request @@ -148736,7 +149428,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *682 + last_response: *685 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -148768,8 +149460,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 zen: description: Random string of GitHub zen. @@ -149014,10 +149706,10 @@ webhooks: - from required: - note - enterprise: *639 - installation: *640 - organization: *641 - project_card: &683 + enterprise: *642 + installation: *643 + organization: *644 + project_card: &686 title: Project Card type: object properties: @@ -149140,7 +149832,7 @@ webhooks: - creator - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -149221,11 +149913,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project_card: *683 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_card: *686 + repository: *645 sender: *4 required: - action @@ -149305,9 +149997,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 project_card: title: Project Card type: object @@ -149437,7 +150129,7 @@ webhooks: repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -149531,11 +150223,11 @@ webhooks: - from required: - note - enterprise: *639 - installation: *640 - organization: *641 - project_card: *683 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_card: *686 + repository: *645 sender: *4 required: - action @@ -149629,9 +150321,9 @@ webhooks: - from required: - column_id - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 project_card: allOf: - title: Project Card @@ -149828,7 +150520,7 @@ webhooks: type: string required: - after_id - repository: *642 + repository: *645 sender: *4 required: - action @@ -149908,10 +150600,10 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - organization: *641 - project: &685 + enterprise: *642 + installation: *643 + organization: *644 + project: &688 title: Project type: object properties: @@ -150038,7 +150730,7 @@ webhooks: - creator - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -150118,10 +150810,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project_column: &684 + enterprise: *642 + installation: *643 + organization: *644 + project_column: &687 title: Project Column type: object properties: @@ -150161,7 +150853,7 @@ webhooks: - name - created_at - updated_at - repository: *642 + repository: *645 sender: *4 required: - action @@ -150240,14 +150932,14 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -150336,11 +151028,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 + repository: *645 sender: *4 required: - action @@ -150420,11 +151112,11 @@ webhooks: type: string enum: - moved - enterprise: *639 - installation: *640 - organization: *641 - project_column: *684 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project_column: *687 + repository: *645 sender: *4 required: - action @@ -150504,11 +151196,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150588,14 +151280,14 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - project: *685 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 repository: anyOf: - type: 'null' - - *642 + - *645 sender: *4 required: - action @@ -150696,11 +151388,11 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150779,11 +151471,11 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 - organization: *641 - project: *685 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + project: *688 + repository: *645 sender: *4 required: - action @@ -150864,9 +151556,9 @@ webhooks: type: string enum: - closed - installation: *640 - organization: *641 - projects_v2: &686 + installation: *643 + organization: *644 + projects_v2: &689 title: Projects v2 Project description: A projects v2 project type: object @@ -151014,9 +151706,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151097,9 +151789,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151220,9 +151912,9 @@ webhooks: type: string to: type: string - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -151305,7 +151997,7 @@ webhooks: type: string enum: - archived - changes: &690 + changes: &693 type: object properties: archived_at: @@ -151321,9 +152013,9 @@ webhooks: - string - 'null' format: date-time - installation: *640 - organization: *641 - projects_v2_item: &687 + installation: *643 + organization: *644 + projects_v2_item: &690 title: Projects v2 Item description: An item belonging to a project type: object @@ -151462,9 +152154,9 @@ webhooks: - 'null' to: type: string - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151546,9 +152238,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151629,9 +152321,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151736,7 +152428,7 @@ webhooks: oneOf: - type: string - type: integer - - &688 + - &691 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -151756,7 +152448,7 @@ webhooks: required: - id - name - - &689 + - &692 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -151785,8 +152477,8 @@ webhooks: oneOf: - type: string - type: integer - - *688 - - *689 + - *691 + - *692 type: - 'null' - string @@ -151809,9 +152501,9 @@ webhooks: - 'null' required: - body - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151908,9 +152600,9 @@ webhooks: type: - string - 'null' - installation: *640 - organization: *641 - projects_v2_item: *687 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -151993,10 +152685,10 @@ webhooks: type: string enum: - restored - changes: *690 - installation: *640 - organization: *641 - projects_v2_item: *687 + changes: *693 + installation: *643 + organization: *644 + projects_v2_item: *690 sender: *4 required: - action @@ -152078,9 +152770,9 @@ webhooks: type: string enum: - reopened - installation: *640 - organization: *641 - projects_v2: *686 + installation: *643 + organization: *644 + projects_v2: *689 sender: *4 required: - action @@ -152161,9 +152853,9 @@ webhooks: type: string enum: - created - installation: *640 - organization: *641 - projects_v2_status_update: &691 + installation: *643 + organization: *644 + projects_v2_status_update: &694 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -152298,9 +152990,9 @@ webhooks: type: string enum: - deleted - installation: *640 - organization: *641 - projects_v2_status_update: *691 + installation: *643 + organization: *644 + projects_v2_status_update: *694 sender: *4 required: - action @@ -152446,9 +153138,9 @@ webhooks: - string - 'null' format: date - installation: *640 - organization: *641 - projects_v2_status_update: *691 + installation: *643 + organization: *644 + projects_v2_status_update: *694 sender: *4 required: - action @@ -152519,10 +153211,10 @@ webhooks: title: public event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - repository @@ -152599,13 +153291,13 @@ webhooks: type: string enum: - assigned - assignee: *666 - enterprise: *639 - installation: *640 - number: &692 + assignee: *669 + enterprise: *642 + installation: *643 + number: &695 description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -154954,7 +155646,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -155036,11 +155728,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -157382,7 +158074,7 @@ webhooks: - draft reason: type: string - repository: *642 + repository: *645 sender: *4 required: - action @@ -157464,11 +158156,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -159810,7 +160502,7 @@ webhooks: - draft reason: type: string - repository: *642 + repository: *645 sender: *4 required: - action @@ -159892,13 +160584,13 @@ webhooks: type: string enum: - closed - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: &693 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: &696 allOf: - - *498 + - *501 - type: object properties: allow_auto_merge: @@ -159960,7 +160652,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *642 + repository: *645 sender: *4 required: - action @@ -160041,12 +160733,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -160126,11 +160818,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *639 - milestone: *397 - number: *692 - organization: *641 - pull_request: &694 + enterprise: *642 + milestone: *400 + number: *695 + organization: *644 + pull_request: &697 title: Pull Request type: object properties: @@ -162457,7 +163149,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -162536,11 +163228,11 @@ webhooks: type: string enum: - dequeued - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -164886,7 +165578,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *642 + repository: *645 sender: *4 required: - action @@ -165010,12 +165702,12 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -165095,11 +165787,11 @@ webhooks: type: string enum: - enqueued - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -167430,7 +168122,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -167510,11 +168202,11 @@ webhooks: type: string enum: - labeled - enterprise: *639 - installation: *640 - label: *665 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + label: *668 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -169862,7 +170554,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -169943,10 +170635,10 @@ webhooks: type: string enum: - locked - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -172292,7 +172984,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -172372,12 +173064,12 @@ webhooks: type: string enum: - milestoned - enterprise: *639 - milestone: *397 - number: *692 - organization: *641 - pull_request: *694 - repository: *642 + enterprise: *642 + milestone: *400 + number: *695 + organization: *644 + pull_request: *697 + repository: *645 sender: *4 required: - action @@ -172456,12 +173148,12 @@ webhooks: type: string enum: - opened - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -172542,12 +173234,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -172627,12 +173319,12 @@ webhooks: type: string enum: - reopened - enterprise: *639 - installation: *640 - number: *692 - organization: *641 - pull_request: *693 - repository: *642 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 + pull_request: *696 + repository: *645 sender: *4 required: - action @@ -173007,9 +173699,9 @@ webhooks: - start_side - side - reactions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -175239,7 +175931,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -175319,7 +176011,7 @@ webhooks: type: string enum: - deleted - comment: &696 + comment: &699 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. @@ -175612,9 +176304,9 @@ webhooks: - start_side - side - reactions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -177832,7 +178524,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -177912,11 +178604,11 @@ webhooks: type: string enum: - edited - changes: *695 - comment: *696 - enterprise: *639 - installation: *640 - organization: *641 + changes: *698 + comment: *699 + enterprise: *642 + installation: *643 + organization: *644 pull_request: type: object properties: @@ -180137,7 +180829,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *642 + repository: *645 sender: *4 required: - action @@ -180218,9 +180910,9 @@ webhooks: type: string enum: - dismissed - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -182453,7 +183145,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 review: description: The review that was affected. type: object @@ -182699,9 +183391,9 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -184815,8 +185507,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 - review: &697 + repository: *645 + review: &700 description: The review that was affected. type: object properties: @@ -185049,12 +185741,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -187401,7 +188093,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_reviewer: title: User type: @@ -187487,12 +188179,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -189846,7 +190538,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190041,12 +190733,12 @@ webhooks: type: string enum: - review_requested - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -192395,7 +193087,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_reviewer: title: User type: @@ -192482,12 +193174,12 @@ webhooks: type: string enum: - review_requested - enterprise: *639 - installation: *640 + enterprise: *642 + installation: *643 number: description: The pull request number. type: integer - organization: *641 + organization: *644 pull_request: title: Pull Request type: object @@ -194827,7 +195519,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 requested_team: title: Team description: Groups of organization members that gives permissions @@ -195011,9 +195703,9 @@ webhooks: type: string enum: - submitted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -197249,8 +197941,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 - review: *697 + repository: *645 + review: *700 sender: *4 required: - action @@ -197330,9 +198022,9 @@ webhooks: type: string enum: - resolved - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -199463,7 +200155,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 sender: *4 thread: type: object @@ -199855,9 +200547,9 @@ webhooks: type: string enum: - unresolved - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 pull_request: title: Simple Pull Request type: object @@ -201971,7 +202663,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *642 + repository: *645 sender: *4 thread: type: object @@ -202365,10 +203057,10 @@ webhooks: type: string before: type: string - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -204703,7 +205395,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -204785,11 +205477,11 @@ webhooks: type: string enum: - unassigned - assignee: *698 - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + assignee: *701 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -207139,7 +207831,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -207218,11 +207910,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *639 - installation: *640 - label: *665 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + label: *668 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -209561,7 +210253,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -209642,10 +210334,10 @@ webhooks: type: string enum: - unlocked - enterprise: *639 - installation: *640 - number: *692 - organization: *641 + enterprise: *642 + installation: *643 + number: *695 + organization: *644 pull_request: title: Pull Request type: object @@ -211974,7 +212666,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *642 + repository: *645 sender: *4 required: - action @@ -212177,7 +212869,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *639 + enterprise: *642 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -212272,8 +212964,8 @@ webhooks: - url - author - committer - installation: *640 - organization: *641 + installation: *643 + organization: *644 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -212861,9 +213553,9 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 registry_package: type: object properties: @@ -213340,7 +214032,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *680 + items: *683 summary: type: string tag_name: @@ -213396,7 +214088,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -213474,9 +214166,9 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 registry_package: type: object properties: @@ -213788,7 +214480,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *680 + items: *683 summary: type: string tag_name: @@ -213838,7 +214530,7 @@ webhooks: - owner - package_version - registry - repository: *642 + repository: *645 sender: *4 required: - action @@ -213915,10 +214607,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - release: &699 + enterprise: *642 + installation: *643 + organization: *644 + release: &702 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -214234,7 +214926,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *642 + repository: *645 sender: *4 required: - action @@ -214311,11 +215003,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -214423,11 +215115,11 @@ webhooks: type: boolean required: - to - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -214505,9 +215197,9 @@ webhooks: type: string enum: - prereleased - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -214828,7 +215520,7 @@ webhooks: - string - 'null' format: uri - repository: *642 + repository: *645 sender: *4 required: - action @@ -214904,10 +215596,10 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - release: &700 + enterprise: *642 + installation: *643 + organization: *644 + release: &703 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -215225,7 +215917,7 @@ webhooks: - string - 'null' format: uri - repository: *642 + repository: *645 sender: *4 required: - action @@ -215301,11 +215993,11 @@ webhooks: type: string enum: - released - enterprise: *639 - installation: *640 - organization: *641 - release: *699 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *702 + repository: *645 sender: *4 required: - action @@ -215381,11 +216073,11 @@ webhooks: type: string enum: - unpublished - enterprise: *639 - installation: *640 - organization: *641 - release: *700 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + release: *703 + repository: *645 sender: *4 required: - action @@ -215461,11 +216153,11 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_advisory: *551 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_advisory: *554 sender: *4 required: - action @@ -215541,11 +216233,11 @@ webhooks: type: string enum: - reported - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_advisory: *551 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_advisory: *554 sender: *4 required: - action @@ -215621,10 +216313,10 @@ webhooks: type: string enum: - archived - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215701,10 +216393,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215782,10 +216474,10 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215870,10 +216562,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -215988,10 +216680,10 @@ webhooks: - 'null' items: type: string - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216063,10 +216755,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 status: type: string @@ -216147,10 +216839,10 @@ webhooks: type: string enum: - privatized - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216227,10 +216919,10 @@ webhooks: type: string enum: - publicized - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216324,10 +217016,10 @@ webhooks: - name required: - repository - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216407,11 +217099,11 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 sender: *4 required: - action @@ -216489,11 +217181,11 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 sender: *4 required: - action @@ -216571,11 +217263,11 @@ webhooks: type: string enum: - edited - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - repository_ruleset: *241 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + repository_ruleset: *244 changes: type: object properties: @@ -216594,16 +217286,16 @@ webhooks: properties: added: type: array - items: *235 + items: *238 deleted: type: array - items: *235 + items: *238 updated: type: array items: type: object properties: - condition: *235 + condition: *238 changes: type: object properties: @@ -216636,16 +217328,16 @@ webhooks: properties: added: type: array - items: *240 + items: *243 deleted: type: array - items: *240 + items: *243 updated: type: array items: type: object properties: - rule: *240 + rule: *243 changes: type: object properties: @@ -216882,10 +217574,10 @@ webhooks: - from required: - owner - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -216963,10 +217655,10 @@ webhooks: type: string enum: - unarchived - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217044,7 +217736,7 @@ webhooks: type: string enum: - create - alert: &701 + alert: &704 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -217168,10 +217860,10 @@ webhooks: type: string enum: - open - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217381,10 +218073,10 @@ webhooks: type: string enum: - dismissed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217462,11 +218154,11 @@ webhooks: type: string enum: - reopen - alert: *701 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217668,10 +218360,10 @@ webhooks: enum: - fixed - open - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217749,7 +218441,7 @@ webhooks: type: string enum: - created - alert: &702 + alert: &705 type: object properties: number: *70 @@ -217837,10 +218529,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -217921,11 +218613,11 @@ webhooks: type: string enum: - created - alert: *702 - installation: *640 - location: *703 - organization: *641 - repository: *642 + alert: *705 + installation: *643 + location: *706 + organization: *644 + repository: *645 sender: *4 required: - location @@ -218163,11 +218855,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218245,11 +218937,11 @@ webhooks: type: string enum: - reopened - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218327,11 +219019,11 @@ webhooks: type: string enum: - resolved - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218409,11 +219101,11 @@ webhooks: type: string enum: - validated - alert: *702 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + alert: *705 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -218489,11 +219181,11 @@ webhooks: type: string enum: - published - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - security_advisory: &704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + security_advisory: &707 description: The details of the security advisory, including summary, description, and severity. type: object @@ -218679,11 +219371,11 @@ webhooks: type: string enum: - updated - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 - security_advisory: *704 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 + security_advisory: *707 sender: *4 required: - action @@ -218756,10 +219448,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -218945,11 +219637,11 @@ webhooks: from: type: object properties: - security_and_analysis: *232 - enterprise: *639 - installation: *640 - organization: *641 - repository: *293 + security_and_analysis: *235 + enterprise: *642 + installation: *643 + organization: *644 + repository: *296 sender: *4 required: - changes @@ -219027,12 +219719,12 @@ webhooks: type: string enum: - cancelled - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: &705 + sponsorship: &708 type: object properties: created_at: @@ -219337,12 +220029,12 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - sponsorship @@ -219430,12 +220122,12 @@ webhooks: type: string required: - from - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219512,17 +220204,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &706 + effective_date: &709 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: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - sponsorship @@ -219596,7 +220288,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &707 + changes: &710 type: object properties: tier: @@ -219640,13 +220332,13 @@ webhooks: - from required: - tier - effective_date: *706 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + effective_date: *709 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219723,13 +220415,13 @@ webhooks: type: string enum: - tier_changed - changes: *707 - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + changes: *710 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - sponsorship: *705 + sponsorship: *708 required: - action - changes @@ -219803,10 +220495,10 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -219890,10 +220582,10 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -220322,15 +221014,15 @@ webhooks: type: - string - 'null' - enterprise: *639 + enterprise: *642 id: description: The unique identifier of the status. type: integer - installation: *640 + installation: *643 name: type: string - organization: *641 - repository: *642 + organization: *644 + repository: *645 sender: *4 sha: description: The Commit SHA. @@ -220440,15 +221132,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 + parent_issue: *101 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 - installation: *640 - organization: *641 - repository: *642 + sub_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220532,15 +221224,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 + parent_issue: *101 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 - installation: *640 - organization: *641 - repository: *642 + sub_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220624,15 +221316,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 + sub_issue: *101 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 - installation: *640 - organization: *641 - repository: *642 + parent_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220716,15 +221408,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *98 + sub_issue: *101 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *98 - installation: *640 - organization: *641 - repository: *642 + parent_issue: *101 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -220801,12 +221493,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - team: &708 + team: &711 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -220999,9 +221691,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -221471,7 +222163,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -221547,9 +222239,9 @@ webhooks: type: string enum: - created - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -222019,7 +222711,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -222096,9 +222788,9 @@ webhooks: type: string enum: - deleted - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -222568,7 +223260,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -222712,9 +223404,9 @@ webhooks: - from required: - permissions - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -223184,7 +223876,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - changes @@ -223262,9 +223954,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *639 - installation: *640 - organization: *641 + enterprise: *642 + installation: *643 + organization: *644 repository: title: Repository description: A git repository @@ -223734,7 +224426,7 @@ webhooks: - topics - visibility sender: *4 - team: *708 + team: *711 required: - action - team @@ -223810,10 +224502,10 @@ webhooks: type: string enum: - started - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 required: - action @@ -223886,17 +224578,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *639 + enterprise: *642 inputs: type: - object - 'null' additionalProperties: true - installation: *640 - organization: *641 + installation: *643 + organization: *644 ref: type: string - repository: *642 + repository: *645 sender: *4 workflow: type: string @@ -223978,10 +224670,10 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: allOf: @@ -224237,7 +224929,7 @@ webhooks: type: string required: - conclusion - deployment: *417 + deployment: *420 required: - action - repository @@ -224316,10 +225008,10 @@ webhooks: type: string enum: - in_progress - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: allOf: @@ -224601,7 +225293,7 @@ webhooks: required: - status - steps - deployment: *417 + deployment: *420 required: - action - repository @@ -224680,10 +225372,10 @@ webhooks: type: string enum: - queued - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: type: object @@ -224829,7 +225521,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *417 + deployment: *420 required: - action - repository @@ -224908,10 +225600,10 @@ webhooks: type: string enum: - waiting - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 workflow_job: type: object @@ -225058,7 +225750,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *417 + deployment: *420 required: - action - repository @@ -225138,12 +225830,12 @@ webhooks: type: string enum: - completed - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object @@ -226162,12 +226854,12 @@ webhooks: type: string enum: - in_progress - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object @@ -227171,12 +227863,12 @@ webhooks: type: string enum: - requested - enterprise: *639 - installation: *640 - organization: *641 - repository: *642 + enterprise: *642 + installation: *643 + organization: *644 + repository: *645 sender: *4 - workflow: *661 + workflow: *664 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index f55cb2d38d..b9b64161f5 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -4685,6 +4685,93 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -5434,6 +5521,96 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -15109,6 +15286,93 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -23559,6 +23823,96 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", @@ -103987,6 +104341,334 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, "copilot-usage-metrics": { "title": "Copilot Usage Metrics", "description": "Summary of Copilot usage.", @@ -283451,6 +284133,161 @@ ] } }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-enterprise": { "value": [ { @@ -311737,6 +312574,15 @@ "type": "integer" } }, + "enterprise-team-slug": { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -313242,6 +314088,16 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "get_all_cost_centers": { "description": "Response when getting cost centers", "content": { diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 4125807036..ca58aab60d 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -3319,6 +3319,77 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -3836,6 +3907,81 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -11016,6 +11162,80 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -17154,6 +17374,81 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -75368,6 +75663,295 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -208803,6 +209387,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -233175,6 +233858,13 @@ components: required: false schema: type: integer + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -234407,6 +235097,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" get_all_cost_centers: description: Response when getting cost centers content: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index f55cb2d38d..b9b64161f5 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -4685,6 +4685,93 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", @@ -5434,6 +5521,96 @@ } } }, + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an enterprise team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-enterprise-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/enterprise-team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for an enterprise team", @@ -15109,6 +15286,93 @@ } } }, + "/orgs/{org}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for an organization", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization.\nOnly organization owners and owners and billing managers of the parent enterprise can view Copilot metrics.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for organization members", @@ -23559,6 +23823,96 @@ } } }, + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + "get": { + "summary": "Get Copilot metrics for a team", + "description": "Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings.\nOnly organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-metrics-for-team", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/team-slug" + }, + { + "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`). Maximum value is 28 days ago.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "until", + "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "name": "per_page", + "description": "The number of days of metrics to display per page (max 28). 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": 28 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/copilot-usage-metrics-day" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/usage_metrics_api_disabled" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-metrics" + } + } + }, "/orgs/{org}/team/{team_slug}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for a team", @@ -103987,6 +104341,334 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, "copilot-usage-metrics": { "title": "Copilot Usage Metrics", "description": "Summary of Copilot usage.", @@ -283451,6 +284133,161 @@ ] } }, + "copilot-usage-metrics-for-day": { + "value": [ + { + "date": "2024-06-24", + "total_active_users": 24, + "total_engaged_users": 20, + "copilot_ide_code_completions": { + "total_engaged_users": 20, + "languages": [ + { + "name": "python", + "total_engaged_users": 10 + }, + { + "name": "ruby", + "total_engaged_users": 10 + } + ], + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 13, + "languages": [ + { + "name": "python", + "total_engaged_users": 6, + "total_code_suggestions": 249, + "total_code_acceptances": 123, + "total_code_lines_suggested": 225, + "total_code_lines_accepted": 135 + }, + { + "name": "ruby", + "total_engaged_users": 7, + "total_code_suggestions": 496, + "total_code_acceptances": 253, + "total_code_lines_suggested": 520, + "total_code_lines_accepted": 270 + } + ] + } + ] + }, + { + "name": "neovim", + "total_engaged_users": 7, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "languages": [ + { + "name": "typescript", + "total_engaged_users": 3, + "total_code_suggestions": 112, + "total_code_acceptances": 56, + "total_code_lines_suggested": 143, + "total_code_lines_accepted": 61 + }, + { + "name": "go", + "total_engaged_users": 4, + "total_code_suggestions": 132, + "total_code_acceptances": 67, + "total_code_lines_suggested": 154, + "total_code_lines_accepted": 72 + } + ] + } + ] + } + ] + }, + "copilot_ide_chat": { + "total_engaged_users": 13, + "editors": [ + { + "name": "vscode", + "total_engaged_users": 13, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 12, + "total_chats": 45, + "total_chat_insertion_events": 12, + "total_chat_copy_events": 16 + }, + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_engaged_users": 1, + "total_chats": 10, + "total_chat_insertion_events": 11, + "total_chat_copy_events": 3 + } + ] + } + ] + }, + "copilot_dotcom_chat": { + "total_engaged_users": 14, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_engaged_users": 14, + "total_chats": 38 + } + ] + }, + "copilot_dotcom_pull_requests": { + "total_engaged_users": 12, + "repositories": [ + { + "name": "demo/repo1", + "total_engaged_users": 8, + "models": [ + { + "name": "default", + "is_custom_model": false, + "custom_model_training_date": null, + "total_pr_summaries_created": 6, + "total_engaged_users": 8 + } + ] + }, + { + "name": "demo/repo2", + "total_engaged_users": 4, + "models": [ + { + "name": "a-custom-model", + "is_custom_model": true, + "custom_model_training_date": "2024-02-01", + "total_pr_summaries_created": 10, + "total_engaged_users": 4 + } + ] + } + ] + } + } + ] + }, "copilot-usage-metrics-enterprise": { "value": [ { @@ -311737,6 +312574,15 @@ "type": "integer" } }, + "enterprise-team-slug": { + "name": "team_slug", + "description": "The slug of the enterprise team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "team-slug": { "name": "team_slug", "description": "The slug of the team name.", @@ -313242,6 +314088,16 @@ } } }, + "usage_metrics_api_disabled": { + "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "get_all_cost_centers": { "description": "Response when getting cost centers", "content": { diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 4125807036..ca58aab60d 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -3319,6 +3319,77 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/enterprises/{enterprise}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only enterprise owners and billing managers can view Copilot metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/copilot/usage": get: summary: Get a summary of Copilot usage for enterprise members @@ -3836,6 +3907,81 @@ paths: enabledForGitHubApps: false category: enterprise-admin subcategory: billing + "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for an enterprise team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. + Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-enterprise-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for an enterprise team @@ -11016,6 +11162,80 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management + "/orgs/{org}/copilot/metrics": + get: + summary: Get Copilot metrics for an organization + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/copilot/usage": get: summary: Get a summary of Copilot usage for organization members @@ -17154,6 +17374,81 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - 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`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). 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: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics "/orgs/{org}/team/{team_slug}/copilot/usage": get: summary: Get a summary of Copilot usage for a team @@ -75368,6 +75663,295 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions, for the given editor. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true copilot-usage-metrics: title: Copilot Usage Metrics description: Summary of Copilot usage. @@ -208803,6 +209387,105 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-usage-metrics-for-day: + value: + - date: '2024-06-24' + total_active_users: 24 + total_engaged_users: 20 + copilot_ide_code_completions: + total_engaged_users: 20 + languages: + - name: python + total_engaged_users: 10 + - name: ruby + total_engaged_users: 10 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 13 + languages: + - name: python + total_engaged_users: 6 + total_code_suggestions: 249 + total_code_acceptances: 123 + total_code_lines_suggested: 225 + total_code_lines_accepted: 135 + - name: ruby + total_engaged_users: 7 + total_code_suggestions: 496 + total_code_acceptances: 253 + total_code_lines_suggested: 520 + total_code_lines_accepted: 270 + - name: neovim + total_engaged_users: 7 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + languages: + - name: typescript + total_engaged_users: 3 + total_code_suggestions: 112 + total_code_acceptances: 56 + total_code_lines_suggested: 143 + total_code_lines_accepted: 61 + - name: go + total_engaged_users: 4 + total_code_suggestions: 132 + total_code_acceptances: 67 + total_code_lines_suggested: 154 + total_code_lines_accepted: 72 + copilot_ide_chat: + total_engaged_users: 13 + editors: + - name: vscode + total_engaged_users: 13 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 12 + total_chats: 45 + total_chat_insertion_events: 12 + total_chat_copy_events: 16 + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_engaged_users: 1 + total_chats: 10 + total_chat_insertion_events: 11 + total_chat_copy_events: 3 + copilot_dotcom_chat: + total_engaged_users: 14 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_engaged_users: 14 + total_chats: 38 + copilot_dotcom_pull_requests: + total_engaged_users: 12 + repositories: + - name: demo/repo1 + total_engaged_users: 8 + models: + - name: default + is_custom_model: false + custom_model_training_date: + total_pr_summaries_created: 6 + total_engaged_users: 8 + - name: demo/repo2 + total_engaged_users: 4 + models: + - name: a-custom-model + is_custom_model: true + custom_model_training_date: '2024-02-01' + total_pr_summaries_created: 10 + total_engaged_users: 4 copilot-usage-metrics-enterprise: value: - day: '2023-10-15' @@ -233175,6 +233858,13 @@ components: required: false schema: type: integer + enterprise-team-slug: + name: team_slug + description: The slug of the enterprise team name. + in: path + required: true + schema: + type: string team-slug: name: team_slug description: The slug of the team name. @@ -234407,6 +235097,13 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + usage_metrics_api_disabled: + description: Copilot Usage Merics API setting is disabled at the organization + or enterprise level. + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" get_all_cost_centers: description: Response when getting cost centers content: